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.
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
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - AccountStatementOrderInput
|
Searches and sorts depending on the given field.
|
query - AccountStatementQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - AcquisitionAdjustmentNoteQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - AcquisitionSupportDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
Response
Returns a BillingResolutionConnectionOutput
Arguments
Name | Description |
---|---|
after - String
|
Seeks forwards after specific ID.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - BillingResolutionOrderInput
|
Searches and sorts depending on the given field.
|
query - BillingResolutionQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - CreditNoteDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - DebitNoteDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
uid - UID!
|
Docuemnt's CUFE/CUDE.
|
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.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - InvoiceDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - OrganizationalUnitOrderInput
|
Searches and sorts depending on the given field.
|
query - OrganizationalUnitQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - InvoiceDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - PurchaseCreditNoteDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - PurchaseDebitNoteDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - DocumentOrderInput
|
Searches and sorts depending on the given field.
|
query - PurchaseDocumentQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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
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.
|
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.
|
before - String
|
Seek backwards before specific ID.
|
first - Int
|
Seek forwards from start of result set.
|
last - Int
|
Seek backwards from end of result set.
|
orderBy - TransactionsOrderInput
|
Searches and sorts depending on the given field.
|
query - TransactionsQueryInput
|
Search depending on the given field.
|
skip - Int
|
Skip result set by given amount.
|
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).
Response
Returns a PurchaseCreditNoteDocumentOutput
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.
|
notifications - String
|
Notifications about plan.
|
organizationUuid - UID
|
The uuid of the organization
|
organizationalUnitUuid - UID
|
The uuid of the organizational unit
|
planName - String
|
The name of the plan
|
planSpecificationEmission - EmissionDataInput
|
Structure for an Emission data.
|
planSpecificationReception - ReceptionDataInput
|
Structure for the Organization's unit contact details.
|
productSpecification - json
|
The Version of the product when the purchase was made
|
productUuid - String
|
The Uuid of the product
|
productVersion - Int
|
The Version of the product when the purchase was made
|
purchaseDate - Date
|
The date the plan was purchased
|
validityDateEnd - Date
|
The date the plan end its validity
|
validityDateStart - Date
|
The date the plan start its validity
|
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 |
---|---|
|
Sort by account statement id in ascending order. |
|
Sort by account statement id in descending order. |
|
Sort by inserted at in ascending order. |
|
Sort by inserted at in descending order. |
|
Sort by plan name in ascending order. |
|
Sort by plan name in descending order. |
|
Sort by purchase at in ascending order. |
|
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.
|
contains - [AccountStatementQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [AccountStatementQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [AccountStatementQueryOptionsInput]
|
List of filters where none must happen.
|
or - [AccountStatementQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [AccountStatementQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
planName - String
|
The Organization's business email.
|
purchaseDate - Date
|
Code that identify each Colombian township.
|
validityDateEnd - Date
|
The name of the township.
|
validityDateStart - Date
|
The name of the township.
|
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.
|
value - String
|
Value to be assigned to this search.
|
Example
{"name": "ID", "value": "xyz789"}
AccountStatementSearchInput
Description
Query options for account statement search statements
Values
Enum Value | Description |
---|---|
|
Text search by ID |
|
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")
|
contact - ContactInput
|
The primary contact for this party.
|
customerAssignedAccountId - String
|
An identifier for the customer's account,assigned by the customer itself.
|
endpointId - EndpointIdInput
|
Structure that defines all the necessary information for an identifier for the end point of the routing service.
|
industryClassificationCode - OrgEconomicActivitiesInput
|
The party's economic activities.
|
partyTaxScheme - PartyTaxSchemeInput
|
Structure that defines all the necessary information for a tax scheme applying to this party.
|
personId - PersonIdInput!
|
Structure that defines all the necessary information for an identifier for this party.
|
personName - PersonNameInput!
|
Structure that defines all the necessary information for the person name for this party.
|
physicalLocation - PhysicalLocationInput
|
Structure that defines all the necessary information for the physical location of this party.
|
supplierAssignedAccountId - String
|
An identifier for the customer's account, assigned by the supplier.
|
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")
|
contact - ContactInput
|
The primary contact for this party.
|
customerAssignedAccountId - String
|
An identifier for the customer's account,assigned by the customer itself.
|
endpointId - EndpointIdInput
|
Structure that defines all the necessary information for an identifier for the end point of the routing service.
|
industryClassificationCode - OrgEconomicActivitiesInput
|
The party's economic activities.
|
partyTaxScheme - PartyTaxSchemeInput!
|
Structure that defines all the necessary information for a tax scheme applying to this party.
|
personId - PersonIdInput!
|
Structure that defines all the necessary information for an identifier for this party.
|
personName - PersonNameInput!
|
Structure that defines all the necessary information for the person name for this party.
|
physicalLocation - PhysicalLocationInput!
|
Structure that defines all the necessary information for the physical location of this party.
|
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.
|
id - EventIdInput!
|
The unique identifier of an Event.
|
issueDate - DateTime!
|
Date and time of the event issuance
|
issuerParty - EventPartyInput!
|
Description of the person/entity who received the event
|
purchaseInvoiceUid - UID!
|
The unique identifier of an already imported Purchase Invoice.
|
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.
|
issueDateTime - DateTime!
|
Date and Time of Issuance.
|
operationCode - AcquisitionAdjustmentNoteOperationType!
|
The Acquirer Support Document's operation.
|
reasonOfIssuance - LocalizedStringInput!
|
The Debit Note's reason of issuance.
|
subtypeCode - AcquisitionAdjustmentNoteSubtype!
|
The Acquirer Support Document's subtype.
|
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.
|
documentModifiers - [AllowanceChargeInput]
|
Input where discount's or charges are found.
|
documentTotals - LegalMonetaryTotalInput!
|
The total amount payable, including allowances, charges, and taxes.
|
generalInformation - AcquisitionAdjustmentNoteGeneralInformationInput!
|
Document's general information.
|
id - DocumentConsecutiveInput!
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
paymentDescription - DocumentPaymentDescriptorInput!
|
Document's Payment Description.
|
referencedDocuments - [DocumentReferenceInput]
|
Additional Documents referenced inside the document
|
supportDocumentToModify - InvoiceIdInput!
|
This structure stores the consecutive and the ID of the support document to be modified.
|
taxDescription - [TaxTotalInput]
|
Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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 of the document |
|
Partial refund of one or more products |
|
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [AcquisitionAdjustmentNoteQueryOptionsInput]
|
List of filters where none must happen.
|
or - [AcquisitionAdjustmentNoteQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
operationCode - AcquisitionAdjustmentNoteOperationType
|
The Invoice's operation.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
subtypeCode - AcquisitionAdjustmentNoteSubtype
|
The Invoice's subtype.
|
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 |
---|---|
|
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.
|
currency - CurrencyCode!
|
Document's Currency code.
|
issueDateTime - DateTime!
|
Date and Time of Issuance.
|
operationCode - AcquisitionSupportDocumentOperationType!
|
The Acquirer Support Document's operation.
|
subtypeCode - AcquisitionSupportDocumentSubtype!
|
The Acquirer Support Document's subtype.
|
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.
|
documentModifiers - [AllowanceChargeInput]
|
Input where discount's or charges are found.
|
documentParties - PurchaseDocumentPartiesInput!
|
Parties involved in the document.
|
documentTotals - LegalMonetaryTotalInput!
|
The total amount payable, including allowances, charges, and taxes.
|
generalInformation - AcquisitionSupportDocumentGeneralInformationInput!
|
Document's general information.
|
id - DocumentConsecutiveInput!
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
organizationalUnitId - UID!
|
Organizational Unit's Id.
|
paymentDescription - DocumentPaymentDescriptorInput!
|
Document's Payment Description.
|
referencedDocuments - [DocumentReferenceInput]
|
Additional Documents referenced inside the document
|
taxDescription - [TaxTotalInput]
|
Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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 |
---|---|
|
Purchase to a non-resident in the country |
|
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [AcquisitionSupportDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [AcquisitionSupportDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
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 |
---|---|
|
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.
|
id - DocumentConsecutiveInput!
|
Document number: Invoice or exchange acquisition support document number. Includes prefix + consecutive acquisition support document number authorized by DIAN.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
reason - LocalizedStringInput!
|
Free text field to enter the reason for cancelling the acquisition support document.
|
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.
|
uid - UID
|
The identificator of the acquisition support document in the system, represented as an uuid or another identificator.
|
Example
{
"id": DocumentConsecutiveInput,
"uid": UID
}
AdditionalAccountId
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.
|
baseAmount - decimal!
|
The monetary amount to which the multiplier factor is applied in calculating the amount of this allowance or charge.
|
chargeIndicator - IndicatorTypeCode!
|
An indicator that this AllowanceCharge describes a charge or a discount.
|
percentage - Float
|
Used for percentaged discounts/charges.
|
reason - LocalizedStringInput!
|
The reason for this allowance or charge.
|
reasonCode - LineModifierCode
|
A code signifying the reason for this allowance or charge.
|
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 |
---|---|
|
Sort by billing_range_id nit in ascending order. |
|
Sort by billing_range_id nit in descending order. |
|
Sort by inserted at in ascending order. |
|
Sort by inserted at in descending order. |
|
Sort by prefix description in ascending order. |
|
Sort by prefix description in descending order. |
|
Sort by resolution number in ascending order. |
|
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.
|
contains - [BillingResolutionQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [BillingResolutionQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [BillingResolutionQueryOptionsInput]
|
List of filters where none must happen.
|
or - [BillingResolutionQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [BillingResolutionQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
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.
|
value - String
|
Value to be assigned to this search.
|
Example
{
"name": "PREFIX_DESCRIPTION",
"value": "abc123"
}
BillingResolutionSearchInput
Description
Query options for billing resolution search
Values
Enum Value | Description |
---|---|
|
Text search by prefix description |
|
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.
|
customerName - NaturalPersonNameInput!
|
Customer's Name
|
customerPoints - Int
|
Customer's account fidelity points.
|
Example
{
"customerIdCode": "xyz789",
"customerName": NaturalPersonNameInput,
"customerPoints": 123
}
ClaimConcept
Description
Claim concept
Values
Enum Value | Description |
---|---|
|
Documento con inconsistencias |
|
Mercancía no entregada totalmente |
|
Mercancía no entregada parcialmente |
|
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.
|
contactId - PersonIdInput
|
Structure with the Contact's ID.
|
email - email
|
Contact's email.
|
name - PersonNameInput
|
Structure with the Contact's Name.
|
phone - String
|
Contact's phone.
|
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.
|
id - PersonIdInput
|
Structure containing a person identifier for this contact.
|
name - PersonNameInput
|
Structure containing the name of this contact.
|
note - [NoteField]
|
Structure containing a Free-form text conveying informaation.
|
otherCommunication - [NoteField]
|
Structure containing another means of communication with this contact.
|
telefax - String
|
The primary fax number of this contact.
|
telephone - String
|
The primary telephone number of this contact.
|
uid - UID
|
Contact identifier in the issuer's system
|
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 |
---|---|
|
Andorra |
|
United Arab Emirates |
|
Afghanistan |
|
Antigua and Barbuda |
|
Anguilla |
|
Albania |
|
Armenia |
|
Angola |
|
Antarctica |
|
Argentina |
|
American Samoa |
|
Austria |
|
Australia |
|
Aruba |
|
Åland Islands |
|
Azerbaijan |
|
Bosnia and Herzegovina |
|
Barbados |
|
Bangladesh |
|
Belgium |
|
Burkina Faso |
|
Bulgaria |
|
Bahrain |
|
Burundi |
|
Benin |
|
Saint Barthélemy |
|
Bermuda |
|
Brunei Darussalam |
|
Bolivia (Plurinational State of) |
|
Bonaire, Sint Eustatius and Saba |
|
Brazil |
|
Bahamas |
|
Bhutan |
|
Bouvet Island |
|
Botswana |
|
Belarus |
|
Belize |
|
Canada |
|
Cocos (Keeling) Islands |
|
Democratic Republic of the Congo |
|
Central African Republic |
|
Congo |
|
Switzerland |
|
Côte d'Ivoire |
|
Cook Islands |
|
Chile |
|
Cameroon |
|
China |
|
Colombia |
|
Costa Rica |
|
Cuba |
|
Cabo Verde |
|
Curaçao |
|
Christmas Island |
|
Cyprus |
|
Czechia |
|
Germany |
|
Djibouti |
|
Denmark |
|
Dominica |
|
Dominican Republic |
|
Algeria |
|
Ecuador |
|
Estonia |
|
Egypt |
|
Western Sahara |
|
Eritrea |
|
Spain |
|
Ethiopia |
|
Finland |
|
Fiji |
|
Falkland Islands (Malvinas) |
|
Micronesia (Federated States of) |
|
Faroe Islands |
|
France |
|
Gabon |
|
United Kingdom of Great Britain and Northern Ireland |
|
Grenada |
|
Georgia |
|
French Guiana |
|
Guernsey |
|
Ghana |
|
Gibraltar |
|
Greenland |
|
Gambia |
|
Guinea |
|
Guadeloupe |
|
Equatorial Guinea |
|
Greece |
|
South Georgia and the South Sandwich Islands |
|
Guatemala |
|
Guam |
|
Guinea-Bissau |
|
Guyana |
|
China, Hong Kong Special Administrative Region |
|
Heard Island and McDonald Islands |
|
Honduras |
|
Croatia |
|
Haiti |
|
Hungary |
|
Indonesia |
|
Ireland |
|
Israel |
|
Isle of Man |
|
India |
|
British Indian Ocean Territory |
|
Iraq |
|
Iran (Islamic Republic of) |
|
Iceland |
|
Italy |
|
Jersey |
|
Jamaica |
|
Jordan |
|
Japan |
|
Kenya |
|
Kyrgyzstan |
|
Cambodia |
|
Kiribati |
|
Comoros |
|
Saint Kitts and Nevis |
|
Democratic People's Republic of Korea |
|
Republic of Korea |
|
Kuwait |
|
Cayman Islands |
|
Kazakhstan |
|
Lao People's Democratic Republic |
|
Lebanon |
|
Saint Lucia |
|
Liechtenstein |
|
Sri Lanka |
|
Liberia |
|
Lesotho |
|
Lithuania |
|
Luxembourg |
|
Latvia |
|
Libya |
|
Morocco |
|
Monaco |
|
Republic of Moldova |
|
Montenegro |
|
Saint Martin (French Part) |
|
Madagascar |
|
Marshall Islands |
|
The former Yugoslav Republic of Macedonia |
|
Mali |
|
Myanmar |
|
Mongolia |
|
China, Macao Special Administrative Region |
|
Northern Mariana Islands |
|
Martinique |
|
Mauritania |
|
Montserrat |
|
Malta |
|
Mauritius |
|
Maldives |
|
Malawi |
|
Mexico |
|
Malaysia |
|
Mozambique |
|
Namibia |
|
New Caledonia |
|
Niger |
|
Norfolk Island |
|
Nigeria |
|
Nicaragua |
|
Netherlands |
|
Norway |
|
Nepal |
|
Nauru |
|
Niue |
|
New Zealand |
|
Oman |
|
Panama |
|
Peru |
|
French Polynesia |
|
Papua New Guinea |
|
Philippines |
|
Pakistan |
|
Poland |
|
Saint Pierre and Miquelon |
|
Pitcairn |
|
Puerto Rico |
|
State of Palestine |
|
Portugal |
|
Palau |
|
Paraguay |
|
Qatar |
|
Réunion |
|
Romania |
|
Serbia |
|
Russian Federation |
|
Rwanda |
|
Saudi Arabia |
|
Solomon Islands |
|
Seychelles |
|
Sudan |
|
Sweden |
|
Singapore |
|
Saint Helena |
|
Slovenia |
|
Svalbard and Jan Mayen Islands |
|
Slovakia |
|
Sierra Leone |
|
San Marino |
|
Senegal |
|
Somalia |
|
Suriname |
|
South Sudan |
|
Sao Tome and Principe |
|
El Salvador |
|
Sint Maarten (Dutch part) |
|
Syrian Arab Republic |
|
Eswatini |
|
Turks and Caicos Islands |
|
Chad |
|
French Southern Territories |
|
Togo |
|
Thailand |
|
Tajikistan |
|
Tokelau |
|
Timor-Leste |
|
Turkmenistan |
|
Tunisia |
|
Tonga |
|
Turkey |
|
Trinidad and Tobago |
|
Tuvalu |
|
Taiwan (Province of China) |
|
United Republic of Tanzania |
|
Ukraine |
|
Uganda |
|
United States Minor Outlying Islands |
|
United States of America |
|
Uruguay |
|
Uzbekistan |
|
Holy See |
|
Saint Vincent and the Grenadines |
|
Venezuela (Bolivarian Republic of) |
|
British Virgin Islands |
|
United States Virgin Islands |
|
Viet Nam |
|
Vanuatu |
|
Wallis and Futuna Islands |
|
Samoa |
|
Yemen |
|
Mayotte |
|
South Africa |
|
Zambia |
|
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [CreditNoteDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [CreditNoteDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
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.
|
issueDateTime - DateTime!
|
Date and Time of Issuance.
|
operationCode - CreditNoteOperationType!
|
The Credit Note's operation.
|
reasonOfIssuance - LocalizedStringInput!
|
The Credit Note's reason of issuance
|
subtypeCode - CreditNoteSubtype!
|
The Credit Note's subtype.
|
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.
|
documentModifiers - [AllowanceChargeInput]
|
documentModifiers |
documentTotals - LegalMonetaryTotalInput!
|
The total amount payable, including allowances, charges, and taxes.
|
generalInformation - CreditNoteGeneralInformationInput!
|
Document's general information.
|
id - DocumentConsecutiveInput!
|
Document number: Credit note number. Includes prefix + consecutive number.
|
invoiceToModify - InvoiceIdInput!
|
This structure stores the consecutive and the ID of the invoice to be modified.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
organizationalUnitId - UID!
|
Organizational Unit's Id.
|
paymentDescription - DocumentPaymentDescriptorInput!
|
Document's Payment Description.
|
referencedDocuments - [DocumentReferenceInput]
|
Additional Documents referenced inside the document.
|
taxDescription - [TaxTotalInput]
|
taxDescription
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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 |
Example
"PARTIAL_REFUND"
CreditNoteSubtype
Description
Credit Note subtypes
Values
Enum Value | Description |
---|---|
|
A regular Credit Note |
Example
"CREDIT_NOTE"
CreditsData
Description
Defines the response object for a Credits Data
Example
{
"annualValue": decimal,
"anualCredits": 123,
"creditValue": decimal,
"monthlyCredits": 123,
"monthlyValue": decimal
}
Currency
Description
Defines the response object for the currency
Example
{
"code": "xyz789",
"description": "abc123"
}
CurrencyCode
Description
Document Currencies
Values
Enum Value | Description |
---|---|
|
United Arab Emi |
|
Afghanistan, Af |
|
Albania, Leke |
|
Armenia, Drams |
|
Netherlands Ant |
|
Angola, Kwanza |
|
Argentina, Peso |
|
Australia, Doll |
|
Aruba, Guilders |
|
Azerbaijan, Man |
|
Bosnia and Herz |
|
Barbados, Dolla |
|
Bangladesh, Tak |
|
Bulgaria, Leva |
|
Bahrain, Dinars |
|
Burundi, Francs |
|
Bermuda, Dollar |
|
Brunei Darussal |
|
Bolivia, Bolivi |
|
Brazil, Brazil |
|
Bahamas, Dollar |
|
Bhutan, Ngultru |
|
Botswana, Pulas |
|
Belarus, Rubles |
|
Belize, Dollars |
|
Canada, Dollars |
|
Congo/Kinshasa |
|
Switzerland, Fr |
|
Chile, Pesos |
|
China, Yuan Ren |
|
Colombia, Pesos |
|
Costa Rica, Col |
|
Cuba, Pesos |
|
Cape Verde, Esc |
|
Cyprus, Pounds |
|
Czech Recurrencies |
|
Djibouti, Franc |
|
Denmark, Kroner |
|
Dominican Repub |
|
Algeria, Algeri |
|
Estonia, Krooni |
|
Egypt, Pounds |
|
Eritrea, Nakfa |
|
Ethiopia, Birr |
|
Euro Member Country |
|
Fiji, Dollars |
|
Falkland Island |
|
United Kingdom |
|
Georgia, Lari |
|
Guernsey, Pound |
|
Ghana, Cedis |
|
Gibraltar, Poun |
|
Gambia, Dalasi |
|
Guinea, Francs |
|
Guatemala, Quet |
|
Guyana, Dollars |
|
Hong Kong, Doll |
|
Croatia, Kuna |
|
Haiti, Gourdes |
|
Hungary, Forint |
|
Indonesia, Rupi |
|
Israel, New She |
|
Isle of Man, Po |
|
India, Rupees |
|
Iraq, Dinars |
|
Iran, Rials |
|
Iceland, Kronur |
|
Jamaica, Dollar |
|
Jordan, Dinars |
|
Japan, Yen |
|
Kenya, Shilling |
|
Kyrgyzstan, Som |
|
Cambodia, Riels |
|
Comoros, Francs |
|
Korea (North) |
|
Korea (South) |
|
Kuwait, Dinars |
|
Cayman Islands, |
|
Kazakstan, Teng |
|
Laos, Kips |
|
Lebanon, Pounds |
|
Sri Lanka, Rupe |
|
Liberia, Dollar |
|
Lesotho, Maloti |
|
Lithuania, Lita |
|
Latvia, Lati |
|
Libya, Dinars |
|
Morocco, Dirham |
|
Moldova, Lei |
|
Madagascar, Ari |
|
Macedonia, Dena |
|
Myanmar (Burma) |
|
Mongolia, Tugri |
|
Macau, Patacas |
|
Mauritania, Oug |
|
Malta, Liri |
|
Mauritius, Rupe |
|
Maldives (Maldi |
|
Malawi, Kwachas |
|
Mexico, Pesos |
|
Malaysia, Ringg |
|
Mozambique, Met |
|
Namibia, Dollar |
|
Nigeria, Nairas |
|
Nicaragua, Gold |
|
Norway, Krone |
|
Nepal, Nepal Ru |
|
New Zealand, Do |
|
Oman, Rials |
|
Panama, Balboa |
|
Peru, Nuevos So |
|
Papua New Guine |
|
Philippines, Pe |
|
Pakistan, Rupee |
|
Poland, Zlotych |
|
Paraguay, Guara |
|
Qatar, Rials |
|
Romania, Lei |
|
Serbia, Dinars |
|
Russia, Rubles |
|
Rwanda, Rwanda |
|
Saudi Arabia, R |
|
Solomon Islands |
|
Seychelles, Rup |
|
Sudan, Dinars |
|
Sudan, Pounds |
|
Sweden, Kronor |
|
Singapore, Doll |
|
Saint Helena, P |
|
Slovenia, Tolar |
|
Slovakia, Korun |
|
Sierra Leone, L |
|
Somalia, Shilli |
|
Suriname, Dolla |
|
Sao Tome and P |
|
El Salvador, Co |
|
Syria, Pounds |
|
Swaziland, Emal |
|
Thailand, Baht |
|
Tajik., Somo. |
|
Turkmenistan, M |
|
Tunisia, Dinars |
|
Tonga, Paanga |
|
Turkey, Liras |
|
Trinidad and To |
|
Tuvalu, Tuvalu |
|
Taiwan, New Dol |
|
Tanzania, Shill |
|
Ukraine, Hryvni |
|
Uganda, Shillin |
|
United States of America, Dollar |
|
Uruguay, Pesos |
|
Uzbekistan, Sum |
|
Venezuela, Boli |
|
Venez.Bol.Frte |
|
Viet Nam, Dong |
|
Vanuatu, Vatu |
|
Samoa, Tala |
|
C. Afri., Fra. |
|
E. Car., Dol. |
|
Africa, Francs |
|
Polyn. Francs |
|
Yemen, Rials |
|
S. Afri., Rands |
|
Zamb., Kwachas |
|
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.
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [DebitNoteDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [DebitNoteDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
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.
|
issueDateTime - DateTime!
|
Date and Time of Issuance.
|
operationCode - DebitNoteOperationType!
|
The Debit Note's operation.
|
reasonOfIssuance - LocalizedStringInput!
|
The Debit Note's reason of issuance.
|
subtypeCode - DebitNoteSubtype!
|
The Debit Note's subtype.
|
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 on the invoice |
|
Expenses for collection |
|
Other reason of issueance |
|
Additional tax charge |
Example
"CHANGE_OF_VALUE"
DebitNoteSubtype
Description
Debit Note subtypes
Values
Enum Value | Description |
---|---|
|
A regular Debit Note |
Example
"DEBIT_NOTE"
DescriptiveCode
DianResolutionDataOutput
Description
Structure with the updated list of the current resolutions
Fields
Field Name | Description |
---|---|
billingResolutions - [BillingResolution]
|
Example
{"billingResolutions": [BillingResolution]}
DocumentConnection
Description
Document union type for e-invoice, Credit Note, Debit Note and Support Document.
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
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.
|
salePoint - SalePointExtensionInput!
|
UBL DIAN Extension to characterize the buyer's benefits for a sale.
|
Example
{
"buyerBenefits": BuyerBenefitsExtensionInput,
"salePoint": SalePointExtensionInput
}
DocumentFiles
Description
Files related to an electronic document
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. |
Possible Types
DocumentInterface Types |
---|
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.
|
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.
|
invoicePeriod - ProductLinePeriodInput
|
An invoicing period related to the product itself.
|
itemDescription - ItemDescriptorInput!
|
Structure that defines all the necessary information for the products or services description.
|
lineExtensionAmount - decimal!
|
lineExtensionAmount(decimal): Amount to be paid without taxes.
|
lineId - Int!
|
Item's id is only used in error messages from yabi.co
|
note - LocalizedStringInput
|
A note for the Product.
|
price - LinePriceInput!
|
Structure that defines all the necessary information for the price of this product. May include Taxes or not.
|
priceModifier - [AllowanceChargeInput]
|
Structure that defines all the necessary information for discounts and/or charges for this product.
|
pricingReference - LinePricingReferenceInput
|
Structure that defines all the necessary information for a pricing refence used for the cases of free samples
|
quantity - decimal!
|
The presentation's quantity.
|
taxDescription - [TaxTotalInput]
|
The total amount of tax.
|
unitCode - UnitCode!
|
The code that characterizes each unit.
|
uuid - UID
|
A UUID for this product.
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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.
Example
{
"key": "xyz789",
"value": "abc123"
}
DocumentNotesOutput
DocumentOrderInput
Description
Code to identify the type of document ordering
Values
Enum Value | Description |
---|---|
|
Sort by consecutive in ascending order. |
|
Sort by consecutive in descending order. |
|
Sort by creation date at in ascending order. |
|
Sort by creation date at in descending order. |
|
Sort by customer document ID in ascending order. |
|
Sort by customer document ID in descending order. |
|
Sort by customer document type in ascending order. |
|
Sort by customer document type in descending order. |
|
Sort by customer email at in ascending order. |
|
Sort by customer email at in descending order. |
|
Sort by customer name at in ascending order. |
|
Sort by customer name at in descending order. |
|
Sort by type operation at in ascending order. |
|
Sort by type operation at in descending order. |
|
Sort by customer document status in ascending order. |
|
Sort by supplier document status in descending order. |
|
Sort by inserted at in ascending order. |
|
Sort by inserted at in descending order. |
|
Sort by organizational unit uuid in ascending order. |
|
Sort by organizational unit uuid in descending order. |
|
Sort by subtotal in ascending order. |
|
Sort by subtotal in descending order. |
|
Sort by supplier document ID in ascending order. |
|
Sort by supplier document ID in descending order. |
|
Sort by supplier document type in ascending order. |
|
Sort by supplier document type in descending order. |
|
Sort by supplier email at in ascending order. |
|
Sort by supplier email at in descending order. |
|
Sort by supplier name at in ascending order. |
|
Sort by supplier name at in descending order. |
|
Sort by taxes in ascending order. |
|
Sort by taxes in descending order. |
|
Sort by total price in ascending order. |
|
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.
|
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.
|
paymentMeans - [PaymentMeanInput!]!
|
Expected means of payment.
|
prepayments - [PrepaidPaymentInput]
|
Expected means of Prepaid Payment.
|
Example
{
"paymentExchangeRate": PaymentExchangeRateInput,
"paymentMeans": [PaymentMeanInput],
"prepayments": [PrepaidPaymentInput]
}
DocumentPeriod
Description
Structure that defines all the necessary information for the document 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
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.
|
value - String!
|
Value to be assigned to this search.
|
Example
{"name": "CONSECUTIVE", "value": "xyz789"}
DocumentQuerySearchNames
Description
Query options for text search statements
Values
Enum Value | Description |
---|---|
|
Text search by the document consecutive |
|
Text search by the person's company name |
|
Text search by person's email |
|
Text search by the person's first surname |
|
Text search by person's first name |
|
Text search by the person's ID or identification |
|
Text search by the person's middle name |
|
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.
|
issueDate - Date
|
Document's date of Issuance.
|
referenceId - String!
|
Document's Prefix and Serial.
|
referenceType - ReferenceTypeCode!
|
Referenced Document Type.
|
uid - UID!
|
Document's CUFE/CUDE/CUDS/UUID
|
Example
{
"description": LocalizedStringInput,
"issueDate": "2007-12-03",
"referenceId": "abc123",
"referenceType": "CONTINGENCY_INVOICE",
"uid": UID
}
DocumentType
Description
Electronic Document Types
Values
Enum Value | Description |
---|---|
|
Refers to credit note document |
|
Refers to debit note document |
|
Refers to the electronic invoice document |
|
Purchase support document |
Example
"CREDIT_NOTE"
EconomicActivityCode
Description
Falta
Values
Enum Value | Description |
---|---|
|
Salaried employees |
|
Pensioners |
|
Individuals and unliquidated successions without economic activity |
|
Individuals Subsidized by Third Parties |
|
Capital Annuitant, only for natural persons and illiquid successions. |
|
Growing of cereals (except rice), leguminous crops and oil seeds |
|
Growing of rice |
|
Growing of vegetables and melons, roots and tubers |
|
Growing of tobacco |
|
Growing of textile plants |
|
Other transitory crops n.e.c. |
|
Growing of tropical and subtropical fruits |
|
Growing of plantain and banana |
|
Growing of coffee |
|
Growing of sugar cane |
|
Growing of cut flower |
|
Growing of oil palm (African palm) and other oleaginous fruits. |
|
Growing of beverage crops |
|
Growing of spices, aromatic and drug crops |
|
Other permanent crops n.e.c. |
|
Plant propagation(activities of nurseries, except forestry nurseries) |
|
Raising of cattle and buffaloes |
|
Raising of horses and other equines |
|
Raising of sheep and goats |
|
Raising of swine/pigs |
|
Raising of poultry |
|
Raising of other animals |
|
Mixed farming |
|
Support activities for crop production |
|
Support activities for animal production |
|
Post-harvest crop activities |
|
Seed processing for propagation |
|
Hunting, trapping and related service activities |
|
Silviculture and other forestry activities |
|
Logging |
|
Gathering of non-wood forest products |
|
Support services to forestry |
|
Marine fishing |
|
Freshwater fishing |
|
Marine aquaculture |
|
Freshwater aquaculture |
|
Mining of hard coal |
|
Mining of lignite |
|
Extraction of crude petroleum |
|
Extraction of natural gas |
|
Mining of iron ores |
|
Mining of uranium and thorium ores |
|
Mining of gold and other precious metals |
|
Mining of nickel ore |
|
Mining of other non-ferrous metal ores |
|
Extraction of stone, sand, common clays, gypsum and anhydrite. |
|
Extraction of industrial clays, limestone, kaolin and bentonites |
|
Extraction of emeralds, precious and semiprecious stones |
|
Mining of chemical and fertilizer minerals |
|
Extraction of salt |
|
Mining of other non-ferrous metal ores |
|
Support activities for petroleum and natural gas extraction |
|
Support activities for other mining and quarrying |
|
Processing and preserving of meat |
|
Processing and preserving of fish, crustaceans and molluscs |
|
Processing and preserving of fruit and vegetables |
|
Manufacture of vegetable and animal oils and fats |
|
Manufacture of dairy products |
|
Manufacture of grain mill products |
|
Manufacture of grain mill products, starches and starch products |
|
Coffee threshing |
|
Decaffeination, roasting and coffee grinding |
|
Other coffee derivatives |
|
Processing and refining of sugar |
|
Manufacture of panela |
|
Manufacture of bakery products |
|
Manufacture of cocoa, chocolate and sugar confectionery |
|
Manufacture of macaroni, noodles, couscous and similar farinaceous products |
|
Manufacture of prepared meals and dishes |
|
Manufacture of other food products n.e.c. |
|
Manufacture of prepared animal feeds |
|
Distilling, rectifying and blending of spirits |
|
Manufacture of non-distilled fermented beverages |
|
Manufacture of malt liquors and malt |
|
Manufacture of soft drinks; production of mineral waters and other bottled waters |
|
Manufacture of tobacco products |
|
Preparation and spinning of textile fibres |
|
Weaving of textiles |
|
Finishing of textiles |
|
Manufacture of knitted and crocheted fabrics |
|
Manufacture of made-up textile articles, except apparel |
|
Manufacture of carpets and rugs |
|
Manufacture of cordage, rope, twine and netting |
|
Manufacture of other textiles n.e.c. |
|
Manufacture of wearing apparel, except fur apparel |
|
Manufacture of articles of fur |
|
Manufacture of knitted and crocheted apparel |
|
Tanning and dressing of leather; dressing and dyeing of fur |
|
Tanning and dressing of leather; manufacture of luggage, handbags, saddlery and harness; dressing and dyeing of fur |
|
Manufacture of luggage, handbags and the like, saddlery and harness |
|
Manufacture of leather and fur footwear, with any type of sole |
|
Manufacture of other footwear, except leather and fur footwear |
|
Manufacture of footwear parts |
|
Sawmilling and planing of wood |
|
Manufacture of veneer sheets and wood-based panels |
|
Manufacture of builders' carpentry and joinery |
|
Manufacture of wooden containers |
|
Manufacture of other products of wood; manufacture of articles of cork, straw and plaiting materials |
|
Manufacture of pulp, paper and paperboard |
|
Manufacture of corrugated paper and paperboard and of containers of paper and paperboard |
|
Manufacture of other articles of paper and paperboard |
|
Printing |
|
Service activities related to printing |
|
Reproduction of recorded media |
|
Manufacture of coke oven products |
|
Manufacture of refined petroleum products |
|
Fuel blending activity |
|
Manufacture of basic chemicals |
|
Manufacture of fertilizers and nitrogen compounds |
|
Manufacture of plastics in primary forms |
|
Manufacture of synthetic rubber in primary forms |
|
Manufacture of pesticides and other agrochemical products |
|
Manufacture of paints, varnishes and similar coatings, printing ink and mastics |
|
Manufacture of soap and detergents, cleaning and polishing preparations, perfumes and toilet preparations |
|
Manufacture of other chemical products n.e.c. |
|
Manufacture of man-made fibres |
|
Manufacture of pharmaceuticals, medicinal chemical and botanical products |
|
Manufacture of rubber tyres and tubes; retreading and rebuilding of rubber tyres |
|
Retreading of used tires |
|
Manufacture of rubber products and other rubber products n.e.c. |
|
Manufacture of basic plastic forms |
|
Manufacture of plastic articles n.e.c |
|
Manufacture of glass and glass products |
|
Manufacture of refractory products |
|
Manufacture of clay building materials |
|
Manufacture of other porcelain and ceramic products |
|
Manufacture of cement, lime and plaster |
|
Manufacture of articles of concrete, cement and plaster |
|
Cutting, shaping and finishing of stone |
|
Manufacture of other non-metallic mineral products n.e.c. |
|
Manufacture of basic iron and steel |
|
Manufacture of basic precious metals |
|
Manufacture of basic precious and other non-ferrous metals |
|
Casting of iron and steel |
|
Casting of non-ferrous metals |
|
Manufacture of structural metal products |
|
Manufacture of tanks, reservoirs and containers of metal |
|
Manufacture of steam generators, except central heating hot water boilers |
|
Manufacture of weapons and ammunition |
|
Forging, pressing, stamping and roll-forming of metal; powder metallurgy |
|
Treatment and coating of metals; machining |
|
Manufacture of cutlery, hand tools and general hardware |
|
Manufacture of other fabricated metal products n.e.c. |
|
Manufacture of electronic components and boards |
|
Manufacture of computers and peripheral equipment |
|
Manufacture of communication equipment |
|
Manufacture of consumer electronics |
|
Manufacture of measuring, testing, navigating and control equipment |
|
Manufacture of watches and clocks |
|
Manufacture of irradiation, electromedical and electrotherapeutic equipment |
|
Manufacture of optical instruments and photographic equipment |
|
Manufacture of magnetic and optical data storage media |
|
Manufacture of electric motors, generators and transformers |
|
Manufacture of electrical energy distribution and control equipment |
|
Manufacture of batteries and accumulators |
|
Manufacture of fibre optic cables |
|
Manufacture of other electronic and electric wires and cables |
|
Manufacture of electric lighting equipment |
|
Manufacture of domestic appliances |
|
Manufacture of other electrical equipment n.e.c |
|
Manufacture of engines and turbines, except aircraft, vehicle and cycle engines |
|
Manufacture of fluid power equipment |
|
Manufacture of other pumps, compressors, taps and valves |
|
Manufacture of bearings, gears, gearing and driving elements |
|
Manufacture of ovens, furnaces and furnace burners |
|
Manufacture of lifting and handling equipment |
|
Manufacture of office machinery and equipment (except computers and peripheral equipment) |
|
Manufacture of power-driven hand tools |
|
Manufacture of other general-purpose machinery n.e.c |
|
Manufacture of agricultural and forestry machinery |
|
Manufacture of metal-forming machinery and machine tools |
|
Manufacture of machinery for metallurgy |
|
Manufacture of machinery for mining, quarrying and construction |
|
Manufacture of machinery for food, beverage and tobacco processing |
|
Manufacture of machinery for textile, apparel and leather production |
|
Manufacture of other special-purpose machinery n.e.c |
|
Manufacture of motor vehicles |
|
Manufacture of bodies (coachwork) for motor vehicles; manufacture of trailers and semi-trailers |
|
Manufacture of parts and accessories for motor vehicles |
|
Building of ships and floating structures |
|
Building of pleasure and sporting boats |
|
Manufacture of railway locomotives and rolling stock |
|
Manufacture of air and spacecraft and related machinery |
|
Manufacture of military fighting vehicles |
|
Manufacture of motorcycles |
|
Manufacture of bicycles and invalid carriages |
|
Manufacture of other transport equipment n.e.c. |
|
Manufacture of furniture |
|
Manufacture of mattresses and bed bases |
|
Manufacture of jewellery, bijouterie and related articles |
|
Manufacture of musical instruments |
|
Manufacture of sports goods |
|
Manufacture of games, toy and puzzles |
|
Manufacture of medical and dental instruments and supplies |
|
Other manufacturing n.e.c. |
|
Repair of fabricated metal products |
|
Repair of machinery |
|
Repair of electronic and optical equipment |
|
Repair of electrical equipment |
|
Repair of transport equipment, except motor vehicles |
|
Repair of other equipment n.e.c. |
|
Installation of industrial machinery and equipment |
|
Electric power generation |
|
Electric power transmission |
|
Electric power distribution |
|
Commercialization of electric energy. |
|
Manufacture of gas; distribution of gaseous fuels through mains |
|
Steam and air conditioning supply |
|
Water collection, treatment and supply |
|
Sewerage |
|
Collection of non-hazardous waste |
|
Collection of hazardous waste |
|
Treatment and disposal of non-hazardous waste |
|
Treatment and disposal of hazardous waste |
|
Materials recovery |
|
Remediation activities and other waste management services |
|
Construction of residential buildings |
|
Construction of non-residential buildings |
|
Construction of roads and railways |
|
Construction of utility projects |
|
Construction of other civil engineering projects |
|
Demolition |
|
Site preparation |
|
Electrical installation |
|
Plumbing, heat and air-conditioning installation |
|
Other construction installation |
|
Building completion and finishing |
|
Other specialized construction activities |
|
Sales of new motor vehicles |
|
Sales of used motor vehicles |
|
Maintenance and repair of motor vehicles |
|
Sale of motor vehicle parts and accessories |
|
Sale of motorcycles and related parts and accessories |
|
Maintenance and repair of motorcycles and related parts and accessories |
|
Wholesale on a fee or contract basis |
|
Wholesale of agricultural raw materials and live animals |
|
Wholesale of food |
|
Wholesale of beverages and tobacco |
|
Wholesale of textiles |
|
Wholesale of clothing |
|
Wholesale of footwear |
|
Wholesale of household appliances and equipment |
|
Wholesale of pharmaceutical, medicinal and cosmetic products |
|
Wholesale of other household goods n.e.c. |
|
Wholesale of computers, computer peripheral equipment and software |
|
Wholesale of electronic and telecommunications equipment and parts |
|
Wholesale of agricultural machinery, equipment and supplies |
|
Wholesale of other machinery and equipment n.e.c |
|
Wholesale of solid, liquid and gaseous fuels and related products |
|
Wholesale of metals and metal ores |
|
Wholesale of construction materials, hardware, plumbing and heating equipment and supplies |
|
Wholesale of basic chemical products, rubber and plastics in primary forms and agricultural chemical products |
|
Wholesale trade in waste, scrap and scrap metal |
|
Wholesale of other products n.e.c. |
|
Non-specialized wholesale trade |
|
Retail sale in non-specialized stores with food, beverages or tobacco predominating |
|
Other retail sale in non-specialized stores |
|
Retail sale of agricultural products for consumption in specialized stores |
|
Retail sale of milk, dairy products and eggs, in specialized establishments |
|
Retail sale of meat (including poultry), meat products, fish and seafood, in specialized establishments |
|
Retail sale of beverages and tobacco in specialized stores |
|
Retail sale of other food products n.e.c., in specialized stores |
|
Retail sale of automotive fuel in specialized stores |
|
Retail trade of lubricants (oils, greases), additives and cleaning products for motor vehicles |
|
Retail sale of computers, peripheral units, software and telecommunications equipment in specialized stores |
|
Retail sale of audio and video equipment in specialized stores |
|
Retail sale of textiles in specialized stores |
|
Retail sale of hardware, paints and glass in specialized stores |
|
Retail sale of carpets, rugs, wall and floor coverings in specialized stores |
|
Retail sale of household appliances and gas appliances, furniture and lighting equipment in specialized stores |
|
Retail sale of household articles and utensils in specialized stores |
|
Retail sale other household articles in specialized stores |
|
Retail sale of books, newspapers and stationary in specialized stores |
|
Retail sale of sporting equipment in specialized stores |
|
Retail sale of cultural and recreation goods in specialized stores |
|
Retail sale of clothing and clothing accessories (including leather goods) in specialized stores |
|
Retail sale of all types of footwear and leather goods and leather substitutes in specialized establishments |
|
Retail sale of pharmaceutical and medical goods, cosmetic and toilet articles in specialized stores |
|
Other retail sale of new goods in specialized stores |
|
Retail sale of second-hand goods |
|
Retail sale via stalls and markets of food, beverages and tobacco products |
|
Retail sale via stalls and markets of textiles, clothing and footwear |
|
Retail sale via stalls and markets of other goods |
|
Retail sale via Internet |
|
Retail sale via mail order houses or mail |
|
Other retail sale not in stores, stalls or markets |
|
Passenger rail transport, interurban |
|
Freight rail transport |
|
Urban and suburban passenger land transport |
|
Other passenger land transport |
|
Freight transport by road |
|
Transport via pipeline |
|
Sea and coastal passenger water transport |
|
Sea and coastal freight water transport |
|
Inland passenger water transport |
|
Inland freight water transport |
|
Domestic passenger air transportation. |
|
International passenger air transportation. |
|
Domestic reight air transport. |
|
International reight air transport. |
|
Warehousing and storage |
|
Service activities incidental to land transportation |
|
Service activities incidental to water transportation |
|
Service activities incidental to air transportation |
|
Cargo handling |
|
Other transportation support activities |
|
Postal activities |
|
Courier activities |
|
Hotels accommodation |
|
Aparthotels accommodation |
|
Resorts Accommodation |
|
Rural accommodation |
|
Other types of visitor accommodations |
|
Camping grounds, recreational vehicle parks and trailer parks |
|
Hourly stay service |
|
Other accommodation n.e.c. |
|
Table service of prepared foods. |
|
Self-service vending of prepared foods. |
|
Ready-to-eat food vending in cafeterias. |
|
Other food service activities n.e.c. |
|
Event catering |
|
Other food service activities |
|
Beverage serving activities |
|
Book publishing |
|
Publishing of directories and mailing lists |
|
Publishing of newspapers, journals and periodicals |
|
Other publishing activities |
|
Software publishing |
|
Motion picture, video and television programme production activities |
|
Motion picture, video and television programme post-production activities |
|
Motion picture, video and television programme distribution activities |
|
Motion picture projection activities |
|
Sound recording and music publishing activities |
|
Radio programming and broadcasting activities |
|
Television programming and broadcasting activities |
|
Wired telecommunications activities |
|
Wireless telecommunications activities |
|
Satellite telecommunications activities |
|
Other telecommunications activities |
|
Computer programming activities |
|
Computer consultancy and computer facilities management activities |
|
Other information technology and computer service activities |
|
Data processing, hosting and related activities |
|
Web portals |
|
News agency activities |
|
Other information service activities n.e.c. |
|
Central banking |
|
Commercial banks |
|
Activities of financial corporations |
|
Activities of financing companies |
|
Second-floor banking |
|
Activities of financial cooperatives |
|
Trusts, funds and similar financial entities |
|
Severance funds |
|
Financial leasing |
|
Financial activities of employee funds and other associative forms of the solidarity sector |
|
Portfolio purchase or factoring activities |
|
Other fund distribution activities |
|
Official special institutions |
|
Capitalization |
|
Other financial service activities, except insurance and pension funding activities, n.e.c. |
|
Non-life insurance |
|
Life insurance |
|
Reinsurance |
|
Health insurance |
|
Health insurance services |
|
Social insurance services in occupational hazards |
|
Social insurance services in family risks |
|
Average premium defined benefit plan |
|
Individual Solidarity Savings System |
|
Administration of financial markets |
|
Security and commodity contracts brokerage |
|
Other activities related to the securities market |
|
Activities of foreign exchange brokerage and special financial services companies |
|
Activities of foreign exchange trading professionals |
|
Other activities auxiliary to financial service activities n.e.c. |
|
Activities of insurance agents and brokers |
|
Other activities auxiliary to insurance and pension funding |
|
Fund management activities |
|
Real estate activities with own or leased property |
|
Real estate activities on a fee or contract basis |
|
Legal activities |
|
Accounting, bookkeeping and auditing activities; tax consultancy |
|
Activities of head offices |
|
Management consultancy activities |
|
Architectural and engineering activities |
|
Architectural and engineering activities and related technical consultancy |
|
Technical testing and analysis |
|
Research and experimental development on natural sciences and engineering |
|
Research and experimental development on social sciences and humanities |
|
Advertising |
|
Market research and public opinion polling |
|
Specialized design activities |
|
Photographic activities |
|
Other professional, scientific and technical activities n.e.c. |
|
Veterinary activities |
|
Renting and leasing of motor vehicles |
|
Renting and leasing of recreational and sports goods |
|
Renting of video tapes and disks |
|
Renting and leasing of other personal and household goods n.e.c. |
|
Renting and leasing of other machinery, equipment and tangible goods n.e.c. |
|
Leasing of intellectual property and similar products, except copyrighted works |
|
Activities of employment placement agencies |
|
Temporary employment agency activities |
|
Other human resources provision |
|
Travel agency activities |
|
Tour operator activities |
|
Other reservation service and related activities |
|
Private security activities |
|
Security systems service activities |
|
Activities of private detectives and private investigators |
|
Combined facilities support activities |
|
General interior cleaning of buildings |
|
Other building and industrial cleaning activities |
|
Landscape care and maintenance service activities |
|
Combined office administrative service activities |
|
Photocopying, document preparation and other specialized office support activities |
|
Activities of call centres |
|
Organization of conventions and trade shows |
|
Activities of collection agencies and credit bureaus |
|
Packaging activities |
|
Other business support service activities n.e.c. |
|
Legislative general public administration activities |
|
Executive general public administration activities |
|
Regulation of the activities of providing health care, education, cultural services and other social services, excluding social security |
|
Regulation of and contribution to more efficient operation of businesses |
|
Activities of control agencies and other institutions |
|
Foreign affairs |
|
Defence activities |
|
Public order and safety activities |
|
Justice administration |
|
Compulsory social security activities |
|
Early Childhood Education |
|
Pre-primary education |
|
Primary education |
|
Basic secondary education |
|
Academic high school education |
|
Technical educa tion |
|
Establishments that combine different levels of education |
|
Professional technical education |
|
Technical education |
|
Education from universities or technological schools |
|
University education |
|
Training for work |
|
Sports and recreation education |
|
Cultural education |
|
Other education n.e.c. |
|
Educational support activities |
|
Hospital and clinic activities, with hospitalization. |
|
Medical practice activities, without hospitalization |
|
Odontological practice activities |
|
Diagnostic support activities |
|
Therapeutic support activities |
|
Other human health activities |
|
General medicalized residential care activities. |
|
Residential care activities for mental retardation, mental health and substance abuse |
|
Actividades de atención en instituciones para personas de edad y personas con discapacidad |
|
Other institutional care activities with accommodation |
|
Social work activities without accommodation for the elderly and disabled |
|
Nursery activities for boys and girls. |
|
Other social work activities without accommodation n.e.c. |
|
Literary creation. |
|
Musical creation. |
|
Theatrical creation. |
|
Audiovisual creation. |
|
Plastic and visual arts. |
|
Theatrical activities. |
|
Live music show activities. |
|
Other live entertainment activities n.e.c. |
|
Library and archives activities |
|
Museums activities and operation of historical sites and buildings |
|
Botanical and zoological gardens and nature reserves activities |
|
Gambling and betting activities |
|
Operation of sports facilities |
|
Activities of sports clubs |
|
Other sports activities |
|
Activities of amusement parks and theme parks |
|
Other amusement and recreation activities n.e.c. |
|
Activities of business and employers membership organizations |
|
Activities of professional membership organizations |
|
Activities of trade unions |
|
Activities of religious organizations |
|
Activities of political organizations |
|
Activities of other membership organizations n.e.c. |
|
Repair of computers and peripheral equipment |
|
Repair of communication equipment |
|
Repair of consumer electronics |
|
Repair of household appliances and home and garden equipment |
|
Repair of footwear and leather goods |
|
Repair of furniture and home furnishings |
|
Repair of other personal and household goods |
|
Washing and (dry-) cleaning of textile and fur products |
|
Hairdressing and other beauty treatment |
|
Funeral and related activities |
|
Other personal service activities n.e.c. |
|
Activities of households as employers of domestic personnel |
|
Undifferentiated goods-producing activities of private households for own use |
|
Undifferentiated service-producing activities of private households for own use |
|
Activities of extraterritorial organizations and bodies |
Example
"CIIU_V4_0010"
EconomicActivityCodeOutput
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.
|
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
}
EndpointId
Description
Structure for the endpoint ID
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.
|
id - String
|
The identication of the endpoint.
|
schemeId - String
|
The identification of the identification scheme.
|
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
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
Structure used to describe the parties related to an event.
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.
|
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.
|
jobDescriptor - JobDescriptorInput
|
A job description for a natural person.
|
partyIdentification - PersonIdInput!
|
An identifier for this party.
|
partyName - PersonNameInput!
|
A name for this party.
|
partyTaxScheme - PartyTaxSchemeInput
|
A tax scheme applying to this party.
|
physicalLocation - PhysicalLocationInput
|
The physical location of this party.
|
postalAddress - PhysicalLocationInput
|
The party's postal address.
|
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.
|
eventNotes - [NoteField]
|
Additional named notes for the event. Each note requires a name or concept.
|
id - EventIdInput!
|
The unique identifier of an Event.
|
issueDate - DateTime!
|
Date and time of the event issuance
|
issuerParty - EventPartyInput
|
Description of the person/entity who received the event
|
purchaseInvoiceUid - UID!
|
The unique identifier of an already imported Purchase Invoice.
|
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.
|
fileType - FileType
|
The file type (Example values: PDF, HTML, XML, etc.).
|
filename - String
|
The name of the file.
|
Example
{
"data": StringBase64,
"fileType": "BITMAP",
"filename": "abc123"
}
FileType
Description
A file's file type
Values
Enum Value | Description |
---|---|
|
Bitmap Image File |
|
Hypertext Markup Language File |
|
Portable Document Format File |
|
Plain Text File (TXT) |
|
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.
|
responsibilities - [String!]
|
Client's list of fiscal responsibilities
|
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 |
---|---|
|
Code indicating that the person is a woman |
|
Code indicating that the person is a man |
|
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. |
Possible Types
GeneralInformationInterface Types |
---|
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 |
---|---|
|
Collection generated in the operation |
|
Weekly accrued collection |
Example
"PER_OPERATION"
IdType
Description
List of identification documents.
Values
Enum Value | Description |
---|---|
|
Citizenship Card |
|
Alien Registration Card |
|
Foreign Identification Document |
|
Tax Identification Number |
|
Foreign Tax Identification Number |
|
Unique Personal Identification Number |
|
Passport |
|
Special Stay Permit |
|
Civil Registry |
|
Foreigners Card |
|
Identity Card |
Example
"CC"
IdTypeOutput
IncomeOwnershipType
Description
Type of ownership over the income of a product
Values
Enum Value | Description |
---|---|
|
Own Income |
|
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 |
---|---|
|
Indicates that the item is a Charge |
|
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
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [InvoiceDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [InvoiceDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
operationCode - InvoiceOperationType
|
The Invoice's operation.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
subtypeCode - InvoiceSubtype
|
The Invoice's subtype.
|
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.
|
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.
|
currency - CurrencyCode!
|
Document's Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
documentPeriod - DocumentPeriodInput
|
The Invoice's invoicing pediod.
|
issueDateTime - DateTime!
|
Date and Time of Issuance.
|
operationCode - InvoiceOperationType!
|
The Invoice's operation.
|
reasonOfIssuance - LocalizedStringInput
|
The Debit Note's reason of issuance.
|
subtypeCode - InvoiceSubtype!
|
The Invoice's subtype.
|
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.
|
uid - UID
|
The identificator of the invoice in the system, represented as an uuid or another identificator.
|
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.
|
documentModifiers - [AllowanceChargeInput]
|
Input where discount's or charges are found.
|
documentParties - DocumentPartiesInput!
|
Parties involved in the document.
|
documentTotals - LegalMonetaryTotalInput!
|
The total amount payable, including allowances, charges, and taxes.
|
generalInformation - InvoiceGeneralInformationInput!
|
Document's general information.
|
id - DocumentConsecutiveInput!
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
organizationalUnitId - UID!
|
Organizational Unit's Id.
|
paymentDescription - DocumentPaymentDescriptorInput!
|
Document's Payment Description.
|
referencedDocuments - [DocumentReferenceInput]
|
Additional Documents referenced inside the document.
|
taxDescription - [TaxTotalInput]
|
Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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 (Administration, contiengencies and utility) |
|
Mandates |
|
Money Exchange |
|
Standard |
|
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.
|
claimConcept - ClaimConcept!
|
Concept for which the invoice is rejected.
|
eventNotes - [NoteField]
|
Additional named notes for the event. Each note requires a name or concept.
|
id - EventIdInput!
|
The unique identifier of an Event.
|
issueDate - DateTime!
|
Date and time of the event issuance
|
issuerParty - EventPartyInput
|
Description of the person/entity who received the event
|
purchaseInvoiceUid - UID!
|
The unique identifier of an already imported Purchase Invoice
|
reason - String!
|
Reason of rejection
|
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 |
---|---|
|
Cheque book invoice |
|
Exportation 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.
|
organizationUnits - [OrganizationalUnitUpdateInput!]
|
List of the organizational units associated with this client.
|
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.
|
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": "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.
|
brandName - String
|
Product or service brand name.
|
incomeType - IncomeOwnershipType
|
Identifying the type of income ownership related to the product.
|
informationContentProviderParty - PartyInput
|
The party responsible for specification of this product or service.
|
manufacturerParty - PartyInput
|
Structure that defines all the necessary information for the product or service manufacturer.
|
modelName - String
|
Product or service name.
|
originCountry - CountryCode
|
Origin country of the products or services.
|
standardItemId - LineItemIdInput!
|
Identifying information for this product or service, assigned according to a standard system.
|
Example
{
"additionalItemProperty": [NoteField],
"brandName": "xyz789",
"incomeType": "SELF_OWNED",
"informationContentProviderParty": PartyInput,
"manufacturerParty": PartyInput,
"modelName": "xyz789",
"originCountry": "AD",
"standardItemId": LineItemIdInput
}
JobDescriptor
JobDescriptorInput
Description
Job description for a natural person.
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 |
---|---|
|
English United States |
|
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
Structure that defines all the necessary information for legal monetary total.
Fields
Input Field | 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!
|
Document net payable value.
|
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
}
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
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.
|
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.
|
Example
{"id": "xyz789", "standardId": "GTIN"}
LineModifierCode
Description
Document line modifier codes
Values
Enum Value | Description |
---|---|
|
Assumed tax discount |
|
Pay one carry the other |
|
Contractual discounts |
|
Prompt payment discount |
|
Free shipping |
|
Specific inventory discounts |
|
Discount for purchase amount |
|
Season discount |
|
Discount for product / service upgrades |
|
General discount |
|
Volume discount |
|
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.
|
priceAmount - decimal!
|
The price of the product.
|
priceChangeReason - String
|
The reason for the price change
|
priceType - PriceType
|
Indicates what type of price it is. (Example value: "COMMERCIAL_VALUE")
|
unitCode - UnitCode
|
The code that characterizes each unit.
|
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.
|
priceType - PriceType!
|
Indicates what type of price it is. (Example value: "COMMERCIAL_VALUE")
|
Example
{"amount": decimal, "priceType": "COMMERCIAL_VALUE"}
LocalizedString
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.
|
text - String!
|
The text.
|
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.
|
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
{
"firstName": "abc123",
"firstSurname": "abc123",
"secondName": "xyz789",
"secondSurname": "abc123"
}
NoteField
Description
Structure that defines all the necessary information for an arbitrady named field
Example
{
"key": "abc123",
"value": "xyz789"
}
NoteFieldOutput
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
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.
|
others - [EconomicActivityCode]
|
Client's secondary economic activities.
|
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.
|
economicActivities - OrgEconomicActivitiesInput
|
The Organization's economic activities.
|
email - email
|
The Organization's business email.
|
phone - String
|
The Organization's business phone. Example: '+57(601) 123 4567' '601 123 4567 / 601 765 4321' '1234567'
|
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
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).
|
organizationContactData - ContactDataUpdateInput
|
Structure for the Organization's contact details.
|
organizationFiscalData - FiscalDataUpdateInput
|
Structure where the fiscal management of the organization is located and a list of the fiscal responsibilities of the organization
|
organizationName - String
|
The organization name.
|
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 |
---|---|
|
Sort by inserted at in ascending order. |
|
Sort by inserted at in descending order. |
|
Sort by organization unit name in ascending order. |
|
Sort by organization unit name in descending order. |
|
Sort by organization unit nit in ascending order. |
|
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.
|
contains - [OrganizationalUnitQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [OrganizationalUnitQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [OrganizationalUnitQueryOptionsInput]
|
List of filters where none must happen.
|
or - [OrganizationalUnitQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [OrganizationalUnitQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
cityName - String
|
The name of the township.
|
countryCode - CountryCode
|
Afabetic country code (Ej. CO, US, etc.).
|
email - email
|
The Organization's business email.
|
organizationUnitName - String
|
The name of the organization unit.
|
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.
|
value - String
|
Value to be assigned to this search.
|
Example
{"name": "CITY_NAME", "value": "abc123"}
OrganizationalUnitSearchInput
Description
Query options for organization unit search
Values
Enum Value | Description |
---|---|
|
Text search by city name |
|
Text search by email |
|
Text search by the organization environment |
|
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.
|
unitName - String
|
The organizational unit name. |
Example
{
"billingResolutions": [UID],
"organizationBusinessData": OrganizationalUnitBusinessDataUpdateInput,
"unitContactData": ContactDataUpdateInput,
"unitId": UID,
"unitName": "xyz789"
}
Page
PageCursors
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.
|
industryClasificationCode - OrgEconomicActivitiesInput
|
Corresponds to the CIUU economic activity code.
|
partyIdentification - PersonIdInput!
|
An identifier for this party.
|
partyName - PersonNameInput!
|
A name for this party.
|
partyTaxScheme - PartyTaxSchemeInput!
|
A tax scheme applying to this party.
|
person - [PersonInput]
|
Natural or legal person responsible for this party.
|
physicalLocation - PhysicalLocationInput
|
The physical location of this party.
|
postalAddress - PhysicalLocationInput
|
The party's postal address.
|
websiteUri - uri
|
The Uniform Resource Identifier (URI) that identifies this party's web site.
|
Example
{
"contact": ContactInput,
"industryClasificationCode": OrgEconomicActivitiesInput,
"partyIdentification": PersonIdInput,
"partyName": PersonNameInput,
"partyTaxScheme": PartyTaxSchemeInput,
"person": [PersonInput],
"physicalLocation": PhysicalLocationInput,
"postalAddress": PhysicalLocationInput,
"websiteUri": uri
}
PartyLegalEntity
Description
Structure for party legal entity
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
Structure that defines all the necessary information for a party legal information group.
Fields
Input Field | Description |
---|---|
shareHolderParty - [ShareHolderPartyInput!]!
|
Where n is the sum of all shareholders up to 100%
|
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.
|
partyLegalEntity - PartyLegalEntityInput
|
Party legal information group.
|
registrationAddress - PhysicalLocationInput
|
The person's fiscal address.
|
registrationName - String!
|
The person's name AKA Razón Social.
|
taxLevelCode - [ResponsibilityCode!]!
|
The person's responsibilities.
|
taxScheme - TaxSchemeCode!
|
The taxation scheme applicable to the party.
|
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
Example
{
"calculationRate": decimal,
"date": "2007-12-03"
}
PaymentIdCode
Description
Payment Id Code
Values
Enum Value | Description |
---|---|
|
Indicates that payment is on credit |
|
Indicates that payment is in cash |
Example
"CREDIT"
PaymentMean
Description
Group of fields for document payment related information
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
Values
Enum Value | Description |
---|---|
|
Instrument not defined |
|
Cash |
|
Reversal Savings Credit |
|
Reversal Savings Debit |
|
Savings Credit |
|
Debit Savings |
|
Bookentry Credit |
|
Bookentry Debit |
|
Concentration of Cash Demand / Disbursement (CCD) Credit (CCD) |
|
Concentration of Cash Demand / Disbursement (CCD) Debit |
|
Credit Corporate Business Payment (CTP) |
|
ACH Credit |
|
Check |
|
Banking project |
|
Certified banking project |
|
Bank check |
|
Exchange note awaiting acceptance |
|
Certified check |
|
Crazy Check |
|
Debit Corporate Business Payment (CTP) |
|
Credit Corporate Trade Exchange Business (CTX) |
|
Debit Business Corporate Exchange (CTX) |
|
ACH Debit |
|
Credit Transfer |
|
Debit Transfer |
|
Cash Concentration / Disbursement Credit plus (CCD+) |
|
Concentration Cash / Disbursement Debit plus (CCD+) |
|
Pre-arranged Payment and Deposit (PPD) |
|
Concentration Cash Savings / Disbursement Credit (CCD) |
|
Concentration Cash Savings / Disbursement Credit (CCD) |
|
Corporate Business Savings Credit Disbursement (CTP) |
|
Payment Corporate Business Savings Debit (CTP) |
|
Corporate Business Exchange Credit (CTX) |
|
ACH Demand Debit Reversal |
|
Debit Business Corporate Trade Exchange (CTX) |
|
Cash Concentration/Disbursement Credit Plus (CCD+) |
|
Bank Consignment |
|
Cash Concentration / Disbursement Debit plus (CCD+) |
|
Exchange Note |
|
Bank Credit Transfer |
|
Interbank Debit Transfer |
|
Bank Debit Transfer |
|
Credit Card |
|
Debit Card |
|
ACH demand credit reversal |
|
Postdraft |
|
Standard French bank telex |
|
Urgent commercial payment |
|
Urgent Treasury Payment |
|
ACH demand credit |
|
Promissory note |
|
Promissory note signed by the creditor |
|
Promissory note signed by the creditor, endorsed by the bank |
|
Promissory note signed by the creditor, guaranteed by a third party |
|
Promissory note signed by the bank |
|
Promissory note signed by a bank and guaranteed by another bank |
|
Promissory note signed |
|
Promissory note signed by a third party and guaranteed by a bank |
|
ACH demand credit |
|
Withdrawal of the note by the creditor |
|
Bonuses |
|
Vouchers |
|
Withdrawal of a note by the creditor from a bank |
|
Withdrawal of note by creditor, guaranteed by another bank |
|
Withdrawal of note by creditor, on a bank guaranteed by a third party |
|
Withdrawal of a note by the creditor on a third party |
|
Withdrawal of a note by the creditor on a third party guaranteed by a bank |
|
Maintain |
|
National or Regional Clearing |
|
Transferable bank note |
|
Transferable local check |
|
Referenced money order |
|
Urgent money order |
|
Open format money order |
|
Payment method requested not used |
|
Clearing between partners |
|
Simplified Transaction Savings Accounts (CATS) (Nequi, Daviplata, etc.) |
|
Mutual agreement |
Example
"CO_1"
PaymentMeanCodeOutput
PaymentMeanId
PaymentMeanInput
Description
Structure that defines all the necessary information for payment methods
Fields
Input Field | Description |
---|---|
paymentDueDate - DateTime
|
Payment deadline.
|
paymentMeanCode - PaymentMeanCode!
|
Method of payment used (e.g. Check, Cash, Card, etc.).
|
paymentMeanId - PaymentIdCode!
|
Payment method identifier (credit or cash).
|
paymentTerms - LocalizedStringInput
|
Text with the payment terms.
|
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
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.
|
genderCode - GenderCode
|
A code signifying the gender of this person.(Example values: "MALE", "FEMALE", "PREFER_NOT_TO_SAY").
|
id - PersonIdInput
|
Structure containing an identifier for this person.
|
name - PersonNameInput
|
name(PersonNameInput): Structure containing the full name of this person.
|
nationality - CountryCode
|
An identifier for this person's nationality. (Example values: CO, US, etc).
|
residenceAddress - PhysicalLocationInput
|
Structure containing this person's address of residence.
|
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.
|
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": "abc123",
"firstName": "abc123",
"firstSurname": "xyz789",
"secondName": "xyz789",
"secondSurname": "xyz789"
}
PersonType
Description
Person type
Values
Enum Value | Description |
---|---|
|
The legal entity responds to a company that may be formed by multiple persons exercising rights and contracting obligations |
|
A natural person is liable for his obligations in his personal capacity |
Example
"LEGAL_ENTITY"
PersonTypeOutput
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"
- countryCode: CO (Here is the list of all country ISO codes).
-
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"
- country: US (Here is the list of all country ISO codes).
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"
- countryCode: CO (Here is the list of all country ISO codes).
-
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"
- country: US (Here is the list of all country ISO codes).
Fields
Input Field | Description |
---|---|
address - String!
|
The Address text.
|
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.
|
country - CountryCode!
|
Afabetic country code (Ej. CO, US, etc.).
|
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
|
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).
|
informationUri - uri
|
The Uniform Resource Identifier (URI) of a document providing information about this location.
|
name - String
|
The name of the location.
|
postalCode - String
|
Postal code of the location.
|
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.
|
documentLines - [DocumentLineInput!]!
|
Input with information concerning products within the document.
|
documentModifiers - [AllowanceChargeInput]
|
Input where discount's or charges are found.
|
documentParties - DocumentPartiesInput!
|
Parties involved in the document.
|
documentTotals - LegalMonetaryTotalInput!
|
The total amount payable, including allowances, charges, and taxes.
|
generalInformation - InvoiceGeneralInformationInput!
|
Document's general information.
|
id - DocumentConsecutiveInput!
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
organizationalUnitId - UID!
|
Organizational Unit's Id.
|
paymentDescription - DocumentPaymentDescriptorInput!
|
Document's Payment Description.
|
referencedDocuments - [DocumentReferenceInput]
|
Additional Documents referenced inside the document.
|
taxDescription - [TaxTotalInput]
|
Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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
Group of fields for information related to an advance payment
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.
|
instructionId - String
|
An identifier for the payment instruction.
|
paidAmount - decimal!
|
Paid amount. Can't be negative or 0
|
paidDateTime - DateTime!
|
paidDateTime(DateTime): The Date and Time when the payment was done. |
paymentInstructions - String
|
Payment instructions.
|
receivedDate - Date
|
The date when the payment was received.
|
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 |
---|---|
|
Indicates that the price type is commercial value |
Example
"COMMERCIAL_VALUE"
PriceTypeOutput
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
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.
|
endDate - Date
|
Indicates the date up to which the products are leaked.
|
startDate - Date!
|
Indicates the date from which the products are leaked.
|
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.
|
eventNotes - [NoteField]
|
Additional named notes for the event. Each note requires a name or concept.
|
id - EventIdInput!
|
The unique identifier of an Event.
|
invoiceUid - UID!
|
The unique identifier of an already created Sale Invoice.
|
issueDate - DateTime!
|
Date and time of the event issuance
|
issuerParty - EventPartyInput!
|
Description of the person/entity who received the event
|
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.
|
eventNotes - [NoteField]
|
Additional named notes for the event. Each note requires a name or concept.
|
id - EventIdInput!
|
The unique identifier of an Event.
|
issueDate - DateTime!
|
Date and time of the event issuance
|
issuerParty - EventPartyInput!
|
Description of the person/entity who received the event
|
purchaseInvoiceUid - UID!
|
The unique identifier of an already imported Purchase Invoice.
|
receptionDate - DateTime!
|
Date and time of the products/service reception
|
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [PurchaseCreditNoteDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [PurchaseCreditNoteDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
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.
|
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [PurchaseDebitNoteDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [PurchaseDebitNoteDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
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.
|
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.
|
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.
|
contains - [DocumentQuerySearchInput]
|
A partial search. The text is a substring of any of the listed fields.
|
endsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the ending substring of any of the listed fields.
|
not - [PurchaseDocumentQueryOptionsInput]
|
List of filters where none must happen.
|
or - [PurchaseDocumentQueryOptionsInput]
|
List of filters where only one has to happen.
|
startsWith - [DocumentQuerySearchInput]
|
A partial search. The text is the starting substring of any of the listed fields.
|
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.
|
currency - CurrencyCode
|
Type Currency code Here is the complete list of possible values for this field, go to page 596 #13.3.3
|
dateRange - DateRangeInput
|
Date range for document search.
|
documentUid - UID
|
This is the document's UUID in YabiCo.
|
id - String
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
issueDate - Date
|
Date on which the document was sent to DIAN.
|
operationCode - InvoiceOperationType
|
The Invoice's operation.
|
organizationalUnitId - UID
|
UID of the organizational unit.
|
personCompStringName - String
|
The company name of the person assigned on the document.
|
personEmail - email
|
The email of the person assigned on the document.
|
personFirstSurname - String
|
First sur name of the person assigned on the document.
|
personFirtsName - String
|
First name of the person assigned on the document.
|
personId - String
|
The identifier of the person assigned on the document.
|
personIdType - IdType
|
Type of person ID.
|
personSecondName - String
|
Middle name of the person assigned on the document.
|
personSecondSurname - String
|
Seecond sur name of the person assigned on the document.
|
subtypeCode - InvoiceSubtype
|
The Invoice's subtype.
|
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.
|
Example
{"cufe": "xyz789"}
ReceptionData
Description
Defines the response object for a Reception Data
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.
|
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
}
ReferenceTypeCode
Description
Type of referenced document
Values
Enum Value | Description |
---|---|
|
Electronic Contingency Invoice |
|
Electronic Credit Note |
|
Electronic Debit Note |
|
Invoice shipping documents |
|
Electronic Invoice |
|
Electronic Invoice |
|
A purchase order for an invoice |
|
Another type of document, other than those mentioned above |
|
Invoice recepit documents |
Example
"CONTINGENCY_INVOICE"
ReferenceTypeOutput
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 |
---|---|
|
International freight forwarder. |
|
Shipping agent. |
|
General bonded warehouse. |
|
International trading company (C.I.). |
|
Trader of the special customs zone of Inírida, Puerto Carreño, Cumaribo and Primavera. |
|
Traders in the special customs zone of Leticia. |
|
Traders of the special customs regime zone of Maicao, Uribia and Manaure. |
|
Traders in the special customs regime zone of Urabá, Tumaco and Guapí. |
|
Merchants of the free port of San Andres, Providencia and Santa Catalina. |
|
Public warehouse for international logistic support. |
|
Private warehouse for industrial processing. |
|
Private warehouse for transformation or assembly. |
|
Free warehouse. |
|
Private aeronautical warehouse. |
|
Private warehouse for international distribution. |
|
Private warehouse for on-board provisions for consumption and to take away. |
|
Private warehouse for urgent shipments. |
|
Private warehouse. |
|
Public warehouse. |
|
Public warehouse for international distribution. |
|
Coffee exporter. |
|
Exporter. |
|
Importer. |
|
Intermediary of postal traffic and express shipments. |
|
Multimodal transport operator. |
|
Customs brokerage company. |
|
Port and dock owner of public or private service. |
|
Carrier under the import and/or export regime. |
|
National carrier for customs transit regime operations. |
|
Commercial user free zone. |
|
Industrial user of goods free zone. |
|
Industrial user of services free zone. |
|
Free zone operator user. |
|
Permanent customs user. |
|
Highly exporting user. |
|
User of special economic zones of export. |
|
Private warehouse of industrial facilities. |
|
Beneficiaries of special export programs PEX. |
|
Private warehouses for goods in transit San Andres. |
|
Observers of import operations. |
|
Users of special import-export systems. |
|
Maritime transporter - import and/or export regime. |
|
Terrestrial transporter import and/or export regime. |
|
Airport of responsibilitieso or private service. |
|
Fluvial transporter import regime. |
|
Industrial user special free zone. |
|
Customs agencies 1. |
|
User Operator Special Free Trade Zone. |
|
Customs agencies 2. |
|
Customs agencies 3. |
|
Customs agencies 4. |
|
National air transporter. |
|
Air, maritime or fluvial transporter modality Cabotage. |
|
Importer of food for human and animal consumption. |
|
Occasional importer. |
|
Importer of machinery and its parts Decree 2261 of 2012. |
|
Beneficiary of the Automotive Industry Promotion Program-PROFIA. |
|
Other type of customs agent. |
|
Agency. |
|
Establishment of commerce. |
|
Agricultural exploitation center. |
|
Animal exploitation center. |
|
Center of mining exploitation. |
|
Center of exploitation of transformation. |
|
Center of exploitation of services. |
|
Office. |
|
Head office. |
|
Branch office. |
|
Office. |
|
Administrations. |
|
Sectional. |
|
Regional. |
|
Quartermaster's offices. |
|
Local or business. |
|
Point of sale. |
|
Factory. |
|
Workshop. |
|
Quarry. |
|
Oil and gas well. |
|
Other lug of type of natural resource extraction. |
|
Other type of establishment. |
|
Special contribution for the administration of justice. |
|
Tax on financial movements. |
|
Tax on patrimony. |
|
Income and complementary tax special regime. |
|
Income tax and complementary tax ordinary regime. |
|
Income and equity. |
|
Income withholding at source. |
|
National stamp withholding. |
|
Sales tax withholding at source. |
|
Customs obligee. |
|
Sales under the common regime. |
|
Sales under the simplified regime. |
|
Large taxpayer. |
|
Exogenous informant. |
|
Self-withholding taxpayer. |
|
Obligation to invoice for income from excluded goods and/or services. |
|
Professionals of purchase and sale of foreign currency. |
|
Transfer pricing. |
|
Producer of exempt goods and/or services (including exporters). |
|
Obtaining NIT Decree 3050 of 1997 (Art. 3). |
|
To declare the entry or exit of foreign currency or legal currency from the country. |
|
Obliged to declare on behalf of third parties. |
|
VAT Withholding Agent. |
|
Consolidated declaration of transfer prices. |
|
Individual declaration of transfer prices. |
|
National Tax on Gasoline and ACPM. |
|
National consumption tax. |
|
Income tax for equity CREE. |
|
Permanent establishment. |
|
Customers selected by resolution of the General Director as obliged to invoice electronically. |
|
Obliged to Invoice Electronically. |
|
PST Technological Services Provider. |
|
Wealth Tax. |
|
Annual declaration of assets abroad. |
|
Obliged to Keep Accounting. |
|
Simple Taxation Regime. |
|
Sales tax. |
|
Not responsible for VAT. |
|
Not responsible for consumption in restaurants and bars. |
|
Real estate consumption tax withholding agent. |
|
Electronic biller. |
|
Other type of obligee. |
|
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.
|
documentModifiers - [AllowanceChargeInput]
|
Input where discount's or charges are found.
|
documentTotals - LegalMonetaryTotalInput!
|
The total amount payable, including allowances, charges, and taxes.
|
generalInformation - DebitNoteGeneralInformationInput!
|
Document's general information.
|
id - DocumentConsecutiveInput!
|
Document number: Invoice or exchange invoice number. Includes prefix + consecutive invoice number authorized by DIAN.
|
invoiceToModify - InvoiceIdInput!
|
This structure stores the consecutive and the ID of the invoice to be modified.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
organizationalUnitId - UID!
|
Organizational Unit's Id.
|
paymentDescription - DocumentPaymentDescriptorInput!
|
Document's Payment Description.
|
referencedDocuments - [DocumentReferenceInput]
|
Additional Documents referenced inside the document
|
taxDescription - [TaxTotalInput]
|
Structure with the information of the total amount of tax, like: the withholding tax, the total tax amount, etc.
|
withholdingsDescription - [WithholdingTotalInput!]
|
The total amount of tax.
|
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
|
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.
|
salePointCashier - SalePointCashierDescriptorInput!
|
Sale Point cashier/seller's descrition
|
salePointId - String!
|
Sale Point ID or code to identify the sale point by the seller.
|
salePointLocation - PhysicalLocationInput!
|
Sale point address.
|
salePointType - String!
|
Sale Point Type.
|
saleSubtotal - decimal!
|
Sale's subtotal.
|
Example
{
"saleCode": "xyz789",
"salePointCashier": SalePointCashierDescriptorInput,
"salePointId": "xyz789",
"salePointLocation": PhysicalLocationInput,
"salePointType": "abc123",
"saleSubtotal": decimal
}
StandardItemIdCode
Description
DIAN's Standard
Values
Enum Value | Description |
---|---|
|
Global Product Identification Numbers - GTIN |
|
Tariff item according to tax statute |
|
Contributor adoption standard |
|
Colombia Compra Eficiente: use the content of the column "Code" |
Example
"GTIN"
StatusDescriptor
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
TacitAcceptanceEventInput
Description
Invoice tacitly accepted by isser.
Fields
Input Field | Description |
---|---|
additionalDocuments - [FileInput]
|
Additional files related to the delivery of the goods.
|
eventNotes - [NoteField]
|
Additional named notes for the event. Each note requires a name or concept.
|
id - EventIdInput!
|
The unique identifier of an Event.
|
issueDate - DateTime!
|
Date and time of the event issuance
|
issuerParty - EventPartyInput
|
Description of the person/entity who received the event
|
saleInvoiceUid - UID!
|
The unique identifier of an already created Sale Invoice.
|
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 |
---|---|
|
IVA: Sales tax |
|
IC: Nominal Departmental Excise Tax |
|
ICA: Industry, Commerce and Notice Tax |
|
INC: National Excise Tax |
|
IC Porcentual: Departmental Excise Tax Percentage |
|
FtoHorticultura: Hortifrutícula Development Quota |
|
Timbre: Stamp Tax |
|
INC Bolsas: National Excise Tax on Plastic Bags |
|
INCarbono: National Carbon Tax |
|
INCombustibles: National Fuel Tax |
|
Sobretasa Combustibles: Fuel surcharge |
|
Retail contribution (Fuels) |
|
Data Consumption Tax |
|
Another tribute or contribution |
Example
"CO_01"
TaxNameOutput
TaxScheme
TaxSchemeCode
Description
Tax scheme code
Values
Enum Value | Description |
---|---|
|
Code for IVA or VAT (Value Added Tax) |
|
Code for INC(National Consumption Tax) |
|
Code for IVA & INC |
|
"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.
|
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.
|
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!
|
Value of the tax: product of the percentage applied to the taxable base.
|
taxableAmount - decimal
|
Taxable base on which the value of the tax is calculated.
|
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.
|
taxAmount - decimal!
|
The total tax amount for a particular taxation scheme.
|
taxConcept - String
|
The tribute's concept. Use only when the taxName is CO_ZZ which is used for other tributes.
|
taxName - TaxCode!
|
The name of this tax category. (Example value: IVA)
|
taxSubtotal - [TaxSubtotalInput!]!
|
One of the subtotals, the sum of which equals the total tax amount for a particular taxation scheme.
|
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
TransactionsOrderInput
Description
Code to identify the type of transaction ordering
Values
Enum Value | Description |
---|---|
|
Sort by inserted at in ascending order. |
|
Sort by inserted at in descending order. |
|
Sort by requested at at in ascending order. |
|
Sort by requested at in descending order. |
|
Sort by responded at at in ascending order. |
|
Sort by responded at in descending order. |
|
Sort by serial in ascending order. |
|
Sort by serial in descending order. |
Example
"INSERTED_AT_ASC"
TransactionsQueryInput
Description
Structure that defines all the necessary information for a transaction query.
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
Description
Quantity Units: @unitCode
DIAN Annex - 13.3.6 - Page 603
Values
Enum Value | Description |
---|---|
|
Small spray |
|
lift |
|
heat lot |
|
group |
|
outfit |
|
ration |
|
shot |
|
stick, military |
|
hundred fifteen kg drum |
|
hundred lb drum |
|
fiftyfive gallon (US) drum |
|
tank truck |
|
car mile |
|
car count |
|
locomotive count |
|
caboose count |
|
empty car |
|
train mile |
|
fuel usage gallon (US) |
|
caboose mile |
|
fixed rate |
|
ton mile |
|
locomotive mile |
|
total car count |
|
total car mile |
|
quarter mile |
|
twenty foot container |
|
forty foot container |
|
decilitre per gram |
|
gram per cubic centimetre |
|
theoretical pound |
|
gram per square centimetre |
|
actual ton |
|
theoretical ton |
|
kilogram per square metre |
|
pound per thousand square feet |
|
radian per second |
|
radian per second squared |
|
roentgen |
|
British thermal unit per hour |
|
cubic centimetre per second |
|
cubic foot per hour |
|
cubic foot per minute |
|
centimetre per second |
|
decibel |
|
kilobyte |
|
kilobecquerel |
|
kilocurie |
|
megagram |
|
megagram per hour |
|
bin |
|
metre per minute |
|
milliröntgen |
|
millivolt |
|
horse power day per air dry metric ton |
|
catch weight |
|
kilogram per air dry metric ton |
|
kilopas:cal square metres per gram |
|
kilopas:cals per millimetre |
|
millilitres per square centimetre second |
|
cubic feet per minute per square foot |
|
ounce per square foot |
|
ounces per square foot per 0,01inch |
|
megajoule |
|
manmonth |
|
pound per pound of product |
|
pound per piece of product |
|
kilogram per kilogram of product |
|
kilogram per piece of product |
|
millilitre per second |
|
millilitre per minute |
|
super bulk bag |
|
fivehundred kg bulk bag |
|
threehundred kg bulk bag |
|
fifty lb bulk bag |
|
fifty lb bag |
|
bulk car load |
|
bobbin |
|
cap |
|
centistokes |
|
twenty pack |
|
microlitre |
|
micrometre (micron) |
|
milliampere |
|
megabyte |
|
milligram per hour |
|
megabecquerel |
|
microfarad |
|
newton per metre |
|
ounce inch |
|
ounce foot |
|
picofarad |
|
pound per hour |
|
ton (US) per hour |
|
kilolitre per hour |
|
theoretical kilograms |
|
theoretical tonne |
|
sitas: |
|
mesh |
|
net kilogram |
|
part per million |
|
barrel (US) per minute |
|
batch |
|
gallon(US) per thousand |
|
MMSCF/day |
|
pounds per thousand |
|
pump |
|
stage |
|
standard cubic foot |
|
hydraulic horse power |
|
count per minute |
|
seismic level |
|
seismic line |
|
percent weight |
|
part per billion (US) |
|
percent per 1000 hour |
|
failure rate in time |
|
pound per square inch, gauge |
|
oersted |
|
test specific scale |
|
volt ampere per pound |
|
watt per pound |
|
ampere tum per centimetre |
|
millipas:cal |
|
gauss |
|
milli-inch |
|
kilogauss |
|
pounds per square inch absolute |
|
henry |
|
kilopound per square inch |
|
foot pound-force |
|
pound per cubic foot |
|
poise |
|
Saybold universal second |
|
stokes |
|
calorie per cubic centimetre |
|
calorie per gram |
|
curl unit |
|
twenty thousand gallon (US) tankcar |
|
ten thousand gallon (US) tankcar |
|
ten kg drum |
|
fifteen kg drum |
|
15 °C calorie |
|
ampere square metre per joule second |
|
angstrom |
|
as:tronomical unit |
|
attojoule |
|
barn |
|
barn per electron volt |
|
barn per steradian electronvolt |
|
barn per steradian |
|
becquerel per kilogram |
|
becquerel per metre cubed |
|
ampere per centimetre |
|
British thermal unit per second square foot degree Rankin |
|
British thermal unit per pound degree Rankin |
|
British thermal unit per second foot degree Rankin |
|
British thermal unit per hour square foot degree Rankin |
|
candela per square metre |
|
cheval vapeur |
|
coulomb metre |
|
coulomb metre squared per volt |
|
coulomb per cubic centimetre |
|
coulomb per cubic metre |
|
ampere per millimetre |
|
coulomb per cubic millimetre |
|
coulomb per kilogram second |
|
coulomb per mole |
|
coulomb per square centimetre |
|
coulomb per square metre |
|
coulomb per square millimetre |
|
cubic centimetre per mole |
|
cubic decimetre per mole |
|
cubic metre per coulomb |
|
cubic metre per kilogram |
|
ampere per square centimetre |
|
cubic metre per mole |
|
ampere per square metre |
|
curie per kilogram |
|
deadweight tonnage |
|
decalitre |
|
decametre |
|
decitex |
|
degree Rankin |
|
denier |
|
ampere square metre |
|
dyne second per cubic centimetre |
|
dyne second per centimetre |
|
dyne second per centimetre to the fifth power |
|
electronvolt |
|
electronvolt per metre |
|
electronvolt square metre |
|
electronvolt square metre per kilogram |
|
erg |
|
erg per centimetre |
|
ampere per square metre kelvin squared |
|
erg per cubic centimetre |
|
erg per gram |
|
erg per gram second |
|
erg per second |
|
erg per second square centimetre |
|
erg per square centimetre second |
|
erg square centimetre |
|
erg square centimetre per gram |
|
exajoule |
|
farad per metre |
|
ampere per square millimetre |
|
femtojoule |
|
femtometre |
|
foot per second squared |
|
foot pound-force per second |
|
freight ton |
|
gal |
|
Gaussian CGS unit of displacement |
|
Gaussian CGS unit of electic current |
|
Gaussian CGS unit of electric charge |
|
ampere second |
|
Gaussian CGS unit of electric field strength |
|
Gaussian CGS unit of electric polarization |
|
Gaussian CGS unit of electric potential |
|
Gaussian CGS unit of magnetization |
|
gigacoulomb per cubic metre |
|
gigaelectronvolt |
|
gigahertz |
|
gigaohm |
|
gigaohm metre |
|
gigapas:cal |
|
rate |
|
gigawatt |
|
gon |
|
gram per cubic metre |
|
gram per mole |
|
gray |
|
gray per second |
|
hectopas:cal |
|
henry per metre |
|
ball |
|
bulk pack |
|
acre |
|
byte |
|
ampere per metre |
|
additional minute |
|
average minute per call |
|
cop |
|
fathom |
|
access line |
|
ampoule |
|
ampere hour |
|
ampere |
|
Year |
|
aluminium pound only |
|
troy ounce or apothecary ounce |
|
anti-hemophilic factor (AHF) unit |
|
suppository |
|
standard atmosphere |
|
technical atmosphere |
|
capsule |
|
powder filled vial |
|
British thermal unit per pound |
|
Btu per cubic foot |
|
barrel (US) per day |
|
joule per kilogram kelvin |
|
joule per metre |
|
joule per metre squared |
|
joule per metre to the fourth power |
|
joule per mole |
|
joule per mole kelvin |
|
joule second |
|
bunk |
|
joule square metre per kilogram |
|
kelvin per watt |
|
kiloampere |
|
kiloampere per square metre |
|
kiloampere per metre |
|
kilobecquerel per kilogram |
|
kilocoulomb |
|
kilocoulomb per cubic metre |
|
kilocoulomb per square metre |
|
kiloelectronvolt |
|
batting pound |
|
kilogram metre per second |
|
kilogram metre squared |
|
kilogram metre squared per second |
|
kilogram per cubic decimetre |
|
kilogram per litre |
|
thermochemical calorie per gram |
|
kilogram-force |
|
kilogram-force metre |
|
kilogram-force metre per second |
|
barrel, imperial |
|
kilogram-force per square metre |
|
kilojoule per kelvin |
|
kilojoule per kilogram |
|
kilojoule per kilogram kelvin |
|
kilojoule per mole |
|
kilomole |
|
kilomole per cubic metre |
|
kilonewton |
|
kilonewton metre |
|
kiloohm |
|
billet |
|
kiloohm metre |
|
kilopond |
|
kilosecond |
|
kilosiemens |
|
kilosiemens per metre |
|
kilovolt per metre |
|
kiloweber per metre |
|
light year |
|
litre per mole |
|
lumen hour |
|
bun |
|
lumen per square metre |
|
lumen per watt |
|
lumen second |
|
lux hour |
|
lux second |
|
maxwell |
|
megaampere per square metre |
|
megabecquerel per kilogram |
|
megacoulomb per cubic metre |
|
cycle |
|
megacoulomb per square metre |
|
megaelectronvolt |
|
megagram per cubic metre |
|
meganewton |
|
meganewton metre |
|
megaohm |
|
megaohm metre |
|
megas:iemens per metre |
|
megavolt |
|
megavolt per metre |
|
joule per cubic metre |
|
reciprocal metre squared reciprocal second |
|
metre to the fourth power |
|
microampere |
|
microbar |
|
microcoulomb |
|
microcoulomb per cubic metre |
|
microcoulomb per square metre |
|
microfarad per metre |
|
batt |
|
microhenry |
|
microhenry per metre |
|
micronewton |
|
micronewton metre |
|
microohm |
|
microohm metre |
|
micropas:cal |
|
microradian |
|
microsecond |
|
microsiemens |
|
bar [unit of pressure] |
|
bas:e box |
|
board |
|
board foot |
|
bag |
|
brush |
|
brake horse power |
|
billion (EUR) |
|
bucket |
|
bas:ket |
|
bale |
|
dry barrel (US) |
|
barrel (US) |
|
bottle |
|
hundred board feet |
|
becquerel |
|
bar [unit of packaging] |
|
bolt |
|
British thermal unit |
|
bushel (US) |
|
bushel (UK) |
|
bas:e weight |
|
box |
|
million BTUs |
|
call |
|
composite product pound (total weight) |
|
millifarad |
|
milligal |
|
milligram per metre |
|
milligray |
|
millihenry |
|
millijoule |
|
millimetre per second |
|
millimetre squared per second |
|
millimole |
|
mole per kilogram |
|
carset |
|
millinewton |
|
millinewton per metre |
|
milliohm metre |
|
millipas:cal second |
|
milliradian |
|
millisecond |
|
millisiemens |
|
millisievert |
|
millitesla |
|
microvolt per metre |
|
millivolt per metre |
|
milliwatt |
|
milliwatt per square metre |
|
milliweber |
|
mole |
|
mole per cubic decimetre |
|
mole per cubic metre |
|
mole per litre |
|
nanoampere |
|
carload |
|
nanocoulomb |
|
nanofarad |
|
nanofarad per metre |
|
nanohenry |
|
nanohenry per metre |
|
nanometre |
|
nanoohm metre |
|
nanosecond |
|
nanotesla |
|
nanowatt |
|
cost |
|
neper |
|
neper per second |
|
picometre |
|
newton metre second |
|
newton metre squared kilogram squared |
|
newton per square metre |
|
newton per square millimetre |
|
newton second |
|
newton second per metre |
|
octave |
|
cell |
|
ohm centimetre |
|
ohm metre |
|
one |
|
parsec |
|
pas:cal per kelvin |
|
pas:cal second |
|
pas:cal second per cubic metre |
|
pas:cal second per metre |
|
petajoule |
|
phon |
|
centipoise |
|
picoampere |
|
picocoulomb |
|
picofarad per metre |
|
picohenry |
|
picowatt |
|
picowatt per square metre |
|
pound gage |
|
pound-force |
|
millicoulomb per kilogram |
|
rad |
|
radian |
|
radian square metre per mole |
|
radian square metre per kilogram |
|
radian per metre |
|
reciprocal angstrom |
|
reciprocal cubic metre |
|
reciprocal cubic metre per second |
|
reciprocal electron volt per cubic metre |
|
reciprocal henry |
|
coil group |
|
reciprocal joule per cubic metre |
|
reciprocal kelvin or kelvin to the power minus one |
|
reciprocal metre |
|
reciprocal metre squared |
|
reciprocal minute |
|
reciprocal mole |
|
reciprocal pas:cal or pas:cal to the power minus one |
|
reciprocal second |
|
reciprocal second per cubic metre |
|
reciprocal second per metre squared |
|
can |
|
carrying capacity in metric ton |
|
candela |
|
Each per month |
|
degree Celsius |
|
hundred |
|
card |
|
centigram |
|
container |
|
cone |
|
connector |
|
coulomb per kilogram |
|
coil |
|
hundred leave |
|
centilitre |
|
square centimetre |
|
cubic centimetre |
|
centimetre |
|
hundred pack |
|
cental (UK) |
|
carboy |
|
as:sortment |
|
coulomb |
|
cartridge |
|
crate |
|
cas:e |
|
carton |
|
metric carat |
|
cup |
|
curie |
|
cover |
|
hundred pounds (cwt) / hundred weight (US) |
|
hundred weight (UK) |
|
cylinder |
|
combo |
|
reciprocal second per steradian |
|
siemens per metre |
|
siemens square metre per mole |
|
sievert |
|
thousand linear yard |
|
sone |
|
square centimetre per erg |
|
square centimetre per steradian erg |
|
metre kelvin |
|
square metre kelvin per watt |
|
reciprocal second per steradian metre squared |
|
square metre per joule |
|
square metre per kilogram |
|
square metre per mole |
|
pen gram (protein) |
|
square metre per steradian |
|
square metre per steradian joule |
|
square metre per volt second |
|
steradian |
|
syphon |
|
terahertz |
|
terajoule |
|
terawatt |
|
terawatt hour |
|
tesla |
|
tex |
|
thermochemical calorie |
|
thermochemical calorie per gram kelvin |
|
thermochemical calorie per second centimetre kelvin |
|
thermochemical calorie per second square centimetre kelvin |
|
thousand litre |
|
tonne per cubic metre |
|
tropical year |
|
unified atomic mas:s unit |
|
var The name of the unit is an acronym for volt-ampere-reactive. |
|
volt squared per kelvin squared |
|
volt - ampere |
|
volt per centimetre |
|
volt per kelvin |
|
millivolt per kelvin |
|
kilogram per square centimetre |
|
volt per metre |
|
volt per millimetre |
|
watt per kelvin |
|
watt per metre kelvin |
|
watt per square metre |
|
watt per square metre kelvin |
|
watt per square metre kelvin to the fourth power |
|
watt per steradian |
|
watt per steradian square metre |
|
weber per metre |
|
roentgen per second |
|
weber per millimetre |
|
minute [unit of angle] |
|
second [unit of angle] |
|
book |
|
block |
|
round |
|
cas:sette |
|
dollar per hour |
|
inch to the fourth power |
|
sandwich |
|
International Table (IT) calorie |
|
International Table (IT) calorie per second centimetre kelvin |
|
International Table (IT) calorie per second square centimetre kelvin |
|
joule square metre |
|
kilogram per mole |
|
International Table (IT)calorie per gram |
|
International Table (IT) calorie per gram kelvin |
|
megacoulomb |
|
beam |
|
draize score |
|
microwatt |
|
microtesla |
|
microvolt |
|
millinewton metre |
|
microwatt per square metre |
|
millicoulomb |
|
millimole per kilogram |
|
millicoulomb per cubic metre |
|
millicoulomb per square metre |
|
dyne per square centimetre |
|
cubic metre (net) |
|
rem |
|
band |
|
second per cubic metre |
|
second per radian cubic metre |
|
joule per gram |
|
pound gross |
|
pallet/unit load |
|
mas:s pound |
|
sleeve |
|
decare |
|
ten day |
|
day |
|
dry pound |
|
disk (disc) |
|
degree |
|
deal |
|
decade |
|
decigram |
|
dispenser |
|
decagram |
|
decilitre |
|
square decimetre |
|
cubic decimetre |
|
decimetre |
|
decinewton metre |
|
dozen piece |
|
dozen pair |
|
displacement tonnage |
|
data record |
|
drum |
|
dram (US) |
|
dram (UK) |
|
dozen roll |
|
drachm (UK) |
|
display |
|
dry ton |
|
centner, metric 100 kg |
|
dyne |
|
pennyweight |
|
dyne per centimetre |
|
directory book |
|
dozen |
|
dozen pack |
|
belt |
|
trailer |
|
gross kilogram |
|
metric long ton |
|
each |
|
electronic mail box |
|
Hundredth of a carat |
|
Ounce per square yard |
|
eleven pack |
|
equivalent gallon |
|
envelope |
|
thousand cubic feet per day |
|
fibre per cubic centimetre of air |
|
degree Fahrenheit |
|
farad |
|
field |
|
thousand cubic feet |
|
million particle per cubic foot |
|
track foot |
|
hundred cubic metre |
|
transdermal patch |
|
micromole |
|
flake ton |
|
million cubic feet |
|
foot |
|
pound per square foot |
|
foot per minute |
|
foot per second |
|
square foot |
|
cubic foot |
|
US gallon per minute |
|
Imperial gallon per minute |
|
microfiche sheet |
|
gallon (US) per day |
|
gigabecquerel |
|
gram per 100 gram |
|
gross barrel |
|
pound per gallon (US) |
|
gram per metre (gram per 100 centimetres) |
|
gram of fissile isotope |
|
great gross |
|
half gallon (US) |
|
gill (US) |
|
gill (UK) |
|
gram per millilitre |
|
gram per kilogram |
|
gram per litre |
|
dry gallon (US) |
|
gallon (UK) |
|
gallon (US) |
|
gram per square metre |
|
gross gallon |
|
milligrams per square metre |
|
milligram per cubic metre |
|
microgram per cubic metre |
|
gram |
|
grain |
|
gross |
|
gross register ton |
|
gross ton |
|
gigajoule |
|
gallon per thousand cubic feet |
|
gigawatt hour |
|
gross yard |
|
gage system |
|
half page – electronic |
|
half litre |
|
hank A unit of length, typically for yarn. |
|
hectare |
|
hectobar |
|
hundred boxes |
|
hundred count |
|
half dozen |
|
hundred feet |
|
hectogram |
|
hundred cubic feet |
|
hundred sheet |
|
hundred international unit |
|
metric horse power |
|
hundred kilogram |
|
hundred feet (linear) |
|
hectolitre |
|
mile per hour |
|
million cubic metre |
|
hectometre |
|
conventional millimetre of mercury |
|
hundred troy ounce |
|
conventional millimetre of water |
|
hectolitre of pure alcohol |
|
hundred square feet |
|
half hour |
|
hertz |
|
hour |
|
hundred yard |
|
inch pound (pound inch) |
|
count per inch |
|
person |
|
inches of water |
|
column inch |
|
inch per minute |
|
impression |
|
inch |
|
square inch |
|
cubic inch |
|
insurance policy |
|
count per centimetre |
|
stone (UK) |
|
inch per second |
|
inch per second squared |
|
joule per kilogram |
|
jumbo |
|
joule per kelvin |
|
jug |
|
megajoule per kilogram |
|
megajoule per cubic metre |
|
joint |
|
joule |
|
jar |
|
kilowatt demand |
|
kilovolt ampere reactive demand |
|
kilovolt ampere reactive hour |
|
kilovolt ampere (reactive) |
|
kilolitre |
|
cake |
|
kilocharacter |
|
kilobar |
|
kilogram decimal |
|
kelvin |
|
kilopacket |
|
keg |
|
kilogram |
|
kilogram per second |
|
kilohertz |
|
kilogram per millimetre width |
|
kilosegment |
|
kilojoule |
|
kilogram per metre |
|
kilometre per hour |
|
square kilometre |
|
kilogram per cubic metre |
|
kilogram of nitrogen |
|
kilogram named substance |
|
knot |
|
milliequivalence caustic potas:h per gram of product |
|
kilopas:cal |
|
kilogram of potas:sium hydroxide (caustic potas:h) |
|
kilogram of potas:sium oxide |
|
kilogram of phosphorus pentoxide (phosphoric anhydride) |
|
kiloroentgen |
|
thousand pound per square inch |
|
kilogram of substance 90 % dry |
|
kilogram of sodium hydroxide (caustic soda) |
|
kit |
|
kilometre |
|
kilotonne |
|
kilogram of uranium |
|
kilovolt - ampere |
|
kilovar |
|
kilovolt |
|
kilograms per millimetre |
|
kilowatt hour |
|
kilowatt |
|
millilitre per kilogram |
|
litre per minute |
|
pound per cubic inch |
|
pound |
|
troy pound (US) |
|
linear centimetre |
|
litre per day |
|
lite |
|
leaf |
|
linear foot |
|
labour hour |
|
linear inch |
|
large spray |
|
link |
|
linear metre |
|
length |
|
lot [unit of procurement] |
|
liquid pound |
|
litre of pure alcohol |
|
layer |
|
lump sum |
|
ton (UK) or long ton (US) |
|
litre |
|
lumen |
|
Month |
|
lux |
|
linear yard per pound |
|
linear yard |
|
magnetic tape |
|
milligram per litre |
|
monetary value |
|
microcurie |
|
micro-inch |
|
million Btu per 1000 cubic feet |
|
machine per unit |
|
mega litre |
|
megametre |
|
megawatt |
|
thousand standard brick equivalent |
|
thousand board feet |
|
millibar |
|
microgram |
|
millicurie |
|
air dry metric ton |
|
milligram per square foot per side |
|
milligram |
|
square mile |
|
thousand |
|
minute [unit of time] |
|
million |
|
million international unit |
|
milligram per square inch |
|
billion (US) |
|
millilitre |
|
square millimetre |
|
cubic millimetre |
|
millimetre |
|
Nautical mile |
|
megapas:cal |
|
thousand metre |
|
cubic metre per hour |
|
cubic metre per second |
|
metre per second squared |
|
mat |
|
square metre |
|
cubic metre |
|
metre |
|
metre per second |
|
number of mults |
|
megavolt - ampere |
|
megawatt hour (1000 kW.h) |
|
pen calorie |
|
number of lines |
|
print point |
|
milligram per kilogram |
|
number of articles |
|
barge |
|
number of bobbins |
|
car |
|
number of cells |
|
net barrel |
|
net litre |
|
newton |
|
message |
|
net gallon (us) |
|
message hour |
|
net imperial gallon |
|
number of international units |
|
number of screens |
|
load |
|
number of packs |
|
train |
|
Number of parcels |
|
Number of pairs |
|
mho |
|
micromho |
|
number of rolls |
|
metric net ton |
|
net register ton |
|
newton metre |
|
vehicle |
|
part per thousand |
|
pound per air dry metric ton |
|
panel |
|
Score |
|
ohm |
|
ounce |
|
two pack |
|
overtime hour |
|
fluid ounce (US) |
|
fluid ounce (UK) |
|
page - electronic |
|
percent |
|
pound per foot |
|
three pack |
|
four pack |
|
five pack |
|
six pack |
|
seven pack |
|
eight pack |
|
nine pack |
|
packet |
|
pas:cal |
|
pair inch |
|
pad |
|
pound equivalent |
|
pallet (lift) |
|
plate |
|
proof gallon |
|
Pitch |
|
pack |
|
pail |
|
pound percentage |
|
pound net |
|
pound per inch of length |
|
page per inch |
|
pair |
|
pint (US) |
|
dry pint (US) |
|
pint (UK) |
|
liquid pint (US) |
|
tray / tray pack |
|
half pint (US) |
|
pound per inch of width |
|
peck dry (US) |
|
peck dry (UK) |
|
meal |
|
page – facsimile |
|
quarter (of a year) |
|
page – hardcopy |
|
quarter dozen |
|
quarter hour |
|
quarter kilogram |
|
quire |
|
quart (US) |
|
dry quart (US) |
|
quart (UK) |
|
liquid quart (US) |
|
quarter (UK) |
|
pica |
|
calorie |
|
thousand cubic metre |
|
rack |
|
rod |
|
ring |
|
running or operating hour |
|
roll metric meas:ure |
|
reel |
|
ream |
|
ream metric meas:ure |
|
roll |
|
pound per ream |
|
revolutions per minute |
|
revolutions per second |
|
reset |
|
revenue ton mile |
|
run |
|
foot squared per second |
|
metre squared per second (square metres/second US) |
|
sixty fourths of an inch |
|
session |
|
storage unit |
|
standard advertising unit |
|
sack |
|
half year (6 months) |
|
scruple |
|
solid pound |
|
section |
|
second [unit of time] |
|
Haz |
|
set |
|
segment |
|
shipping ton |
|
as:sembly |
|
siemens |
|
split tank truck |
|
slipsheet |
|
mile (statute mile) |
|
square rod |
|
spool |
|
Son |
|
shelf package |
|
square |
|
strip |
|
sheet metric meas:ure |
|
short standard (7200 matches) |
|
sheet |
|
net ton (2000 lb) |
|
skid |
|
shipment |
|
telecommunication line in service |
|
thousand pound gross |
|
thousand piece |
|
thousand bag |
|
thousand cas:ing |
|
thousand gallon (US) |
|
thousand impression |
|
thousand linear inch |
|
tenth cubic foot |
|
kiloampere hour (thousand ampere hour) |
|
truckload |
|
therm |
|
tote |
|
ten square yard |
|
thousand square inch |
|
thousand square centimetre |
|
tank, rectangular |
|
thousand feet (linear) |
|
tin |
|
metric ton |
|
Number of parts |
|
ten pack |
|
ten pair |
|
thousand feet |
|
thousand cubic metre per day |
|
ten square feet |
|
trillion (EUR) |
|
thousand square feet |
|
tonne of substance 90 % dry |
|
ton of steam per hour |
|
thousand linear metre |
|
tube |
|
thousand kilogram |
|
thousand sheet |
|
tank, cylindrical |
|
treatment |
|
tablet |
|
torr |
|
telecommunication line in service average |
|
telecommunication port |
|
tenth minute |
|
tenth hour |
|
usage per telecommunication line average |
|
ten thousand yard |
|
million unit |
|
volt ampere per kilogram |
|
vial |
|
volt |
|
bulk |
|
visit |
|
wet kilo |
|
two week |
|
watt per kilogram |
|
wet pound |
|
cord |
|
wet ton |
|
weber |
|
week |
|
wine gallon |
|
wheel |
|
watt hour |
|
weight per square inch |
|
working month |
|
wrap |
|
standard |
|
watt |
|
millilitre of water |
|
chain |
|
square yard |
|
cubic yard |
|
hundred linear yard |
|
yard |
|
ten yard |
|
lift van |
|
chest |
|
cas:k |
|
hogshead |
|
lug |
|
conference point |
|
newspage agate line |
|
page |
|
mutually defined |
|
alcoholic strength by mas:s |
|
alcoholic strength by volume |
Example
"CO_04"
UnitCodeOutput
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.
|
invoiceToVoid - InvoiceIdInput!
|
This structure stores the consecutive and the ID of the invoice to be voided.
|
issuerSoftwareSystem - IssuerSoftwareSystem
|
Additional information to inform the software system issuing the document.
|
notes - [DocumentNotes]
|
Additional information: Free text, related to the document.
|
reason - LocalizedStringInput!
|
Free text field to enter the reason for cancelling the invoice.
|
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 |
---|---|
|
ReteIVA: IVA withholding |
|
ReteRenta: Income Tax Withholding |
|
ReteICA: ICA withholding |
Example
"CO_05"
WithholdingNameOutput
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.
|
withholdingAmount - decimal!
|
The total withholding amount for a particular withholding scheme.
|
withholdingName - WithholdingCode!
|
he name of this withholding category
|
withholdingSubtotal - [TaxSubtotalInput!]!
|
One of the subtotals the sum of which equals the total withholding amount for a particular withholding scheme
|
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.
|
organizationalUnitId - UID!
|
Unit used to issue the document.
|
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
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
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