YABI•CO E-INVOICE GRAPHQL API REFERENCE

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

Contact

API Support

soporte@yabi.co

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

GraphQL

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

Client Libraries

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

Authentication

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

Electronic Documents Reception

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

DIAN Events

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

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

Document Status

Sales invoice status

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

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

Purchase invoice status

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

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

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

Credit note status

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

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

Debit note status

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

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

Acquisition support document status

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

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

Error codes

Error processing

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

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

Error Code Standard

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

Application errors

Code range:`0XX-YYZ`

Request Errors (000-XY):

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

Validation errors (001-XYZ):

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

DIAN Errors (002-X)

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

Pagination Errors (003-X)

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

YABI•CO Errors (004-X)

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

Authentication Errors (090)

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

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

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

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

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

Definitions

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

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

Queries

accountStatement

Description

Query YabiCo's Plan Summary.

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

Response

Returns an AccountStatement

Arguments
Name Description
id - UID!

Unique identifier of the organization.

  • Mandatory: required

Example

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

accountStatements

Description

Query one or more account statements.

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

Response

Returns an AccountStatementConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - AccountStatementOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - AccountStatementQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

acquisitionAdjustmentNote

Description

Query one acquisition adjustment note.

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

Response

Returns an AcquisitionAdjustmentNoteDocument

Arguments
Name Description
uid - UID!

Unique identifier of the acquisition adjustment note.

  • Mandatory: required

Example

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

acquisitionAdjustmentNotes

Description

Query one or more electronic acquisition support document notes.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - AcquisitionAdjustmentNoteQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

acquisitionSupportDocument

Description

Query one electronic support document.

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

Response

Returns an AcquisitionSupportDocument

Arguments
Name Description
uid - UID!

Unique identifier of the acquisition support document.

  • Mandatory: required

Example

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

acquisitionSupportDocuments

Description

Query one or more electronic acquisition support documents.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - AcquisitionSupportDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

billingResolution

Description

Query one Organization's Billing Resolution.

Query one Organization's Billing Resolution by its UID.

Response

Returns a BillingResolution

Arguments
Name Description
id - UID!

Unique identifier of the billing resolution.

  • Mandatory: required

Example

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

billingResolutions

Description

Query one or more Organization's Billing Resolution.

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

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - BillingResolutionOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - BillingResolutionQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

creditNote

Description

Query one electronic sale credit note.

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

Response

Returns a CreditNote

Arguments
Name Description
uid - UID!

Unique identifier for a credit note.

  • Mandatory: required

Example

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

creditNotes

Description

Query one or more electronic sale credit notes.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - CreditNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

debitNote

Description

Query one electronic debit note.

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

Response

Returns a DebitNote

Arguments
Name Description
uid - UID!

Unique debit note identifier.

  • Mandatory: required

Example

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

debitNotes

Description

Query one or more electronic sale debit notes.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - DebitNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

electronicDocument

Description

Query one electronic document.

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

The types of documents are:

  • Invoice
  • Credit Note
  • Debit Note
Response

Returns an AcquisitionAdjustmentNoteDocument

Arguments
Name Description
documentType - DocumentType!

Docuemnt's type.

  • Mandatory: required
uid - UID!

Docuemnt's CUFE/CUDE.

  • Mandatory: required

Example

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

electronicInvoicer

Description

Query one ectronic invoicer.

Makes the query of an electronic invoicer by its ID.

Response

Returns an ElectronicInvoicer

Arguments
Name Description
id - String

Unique identifier of the electronic invoicer.

  • Mandatory: required

Example

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

invoice

Description

Query one electronic sale invoice

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

Response

Returns an Invoice

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

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

invoices

Description

Query one or more electronic sale invoices.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - InvoiceDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

organization

Description

Query one Organization.

Query an organization using the client's access token.

Response

Returns an Organization

Example

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

organizationUnit

Description

Query one Business Unit.

Query one Business Unit by its UID.

Response

Returns an OrganizationUnit

Arguments
Name Description
id - UID!

Unique identifier of the organizational unit.

  • Mandatory: required

Example

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

organizationUnits

Description

Query one or more bussines units.

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

Response

Returns an OrganizationUnitConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - OrganizationalUnitOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - OrganizationalUnitQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

posInvoice

Description

Query one electronic sale POS invoice

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

Response

Returns a PosInvoice

Arguments
Name Description
uid - UID!

PosInvoice unique identifier.

  • Mandatory: required

Example

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

posInvoices

Description

Query one or more electronic sale POS invoices.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - InvoiceDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

purchaseCreditNote

Description

Query one electronic purchase credit note.

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

Response

Returns a PurchaseCreditNoteDocument

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

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

purchaseCreditNotes

Description

Query one or more electronic purchase credit notes.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - PurchaseCreditNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

purchaseDebitNote

Description

Query one electronic purchase debit note.

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

Response

Returns a PurchaseDebitNoteDocument

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

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

purchaseDebitNotes

Description

Query one or more electronic purchase debit notes.

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - PurchaseDebitNoteDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

purchaseInvoice

Description

Query one electronic purchase invoice

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

Response

Returns a PurchaseDocument

Arguments
Name Description
uid - UID!

Invoice unique identifier.

  • Mandatory: required

Example

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

purchaseInvoices

Description

Query one or more electronic purchase invoices

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

Response

Returns a DocumentConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - DocumentOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - PurchaseDocumentQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

report

Description

Query Report Summary.

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

Response

Returns a Report

Arguments
Name Description
orgId - UID!

Unique identifier of the organization.

  • Mandatory: required
planId - UID
unitId - UID!

Example

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

transaction

Description

Query a transaction.

Query to search for a transaction by its ID.

Response

Returns a Transaction

Arguments
Name Description
id - UID!

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

  • Mandatory: required

Example

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

transactions

Description

Query one or more transactions.

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

Response

Returns a TransactionConnection

Arguments
Name Description
after - String

Seeks forwards after specific ID.

  • Mandatory: optional
before - String

Seek backwards before specific ID.

  • Mandatory: optional
first - Int

Seek forwards from start of result set.

  • Mandatory: optional
last - Int

Seek backwards from end of result set.

  • Mandatory: optional
orderBy - TransactionsOrderInput

Searches and sorts depending on the given field.

  • Mandatory: optional
query - TransactionsQueryInput

Search depending on the given field.

  • Mandatory: optional
skip - Int

Skip result set by given amount.

  • Mandatory: optional

Example

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

Mutations

addEvent

Description

Adds an Invoice Event.

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

Response

Returns an EventOutput

Arguments
Name Description
document - InvoiceEventInput!

Example

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

addPurchaseCreditNote

Description

Adds a Purchase Credit Note.

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

Arguments
Name Description
document - PurchaseCreditNoteInput!

Example

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

addPurchaseDebitNote

Description

Adds a Purchase Debit Note.

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

Response

Returns a PurchaseDebitNoteDocumentOutput

Arguments
Name Description
document - PurchaseDebitNoteInput!

Example

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

addPurchaseInvoice

Description

Adds a Purchase Invoice.

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

Response

Returns a PurchaseInvoiceDocumentOutput

Arguments
Name Description
document - PurchaseInvoiceInput!

Example

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

createAccountStatement

Description

Add a Account Statement.

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

Response

Returns an AccountStatementOutput

Arguments
Name Description
data - AccountStatementInput!

Example

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

createAcquisitionAdjustmentNote

Description

Create one Support Document Note.

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

Response

Returns an AcquisitionAdjustmentNoteOutput

Arguments
Name Description
document - AcquisitionAdjustmentNoteInput!

Example

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

createAcquisitionSupportDocument

Description

Create one Support Document.

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

Response

Returns an AcquisitionSupportDocumentOutput

Arguments
Name Description
document - AcquisitionSupportDocumentInput!

Example

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

createCreditNote

Description

Create one Credit Note.

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

Response

Returns a CreditNoteDocumentOutput

Arguments
Name Description
document - CreditNoteInput!

Example

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

createDebitNote

Description

Create one Debit Note.

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

Response

Returns a DebitNoteDocumentOutput

Arguments
Name Description
document - SaleDebitNoteInput!

Example

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

createDocument

Description

Creates one Document.

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

Response

Returns a DocumentOutput

Arguments
Name Description
document - XmlFileInput!

Example

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

createInvoice

Description

Create one Invoice.

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

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

Returns an InvoiceDocumentOutput

Arguments
Name Description
document - InvoiceInput!

Example

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

createPosInvoice

Description

Create one POS Invoice.

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

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

Returns a PosInvoiceDocumentOutput

Arguments
Name Description
document - PosInvoiceInput!

Example

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

eventInvoiceExpressAcceptance

Description

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

Create the "Explicit Acceptance" event (ExplicitAcceptanceEventInput).

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

Response

Returns an EventOutput

Arguments
Name Description
data - ExpressAcceptanceEventInput!

Example

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

eventInvoiceProductsDelivery

Description

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

Create the Goods and Services delivered event (ProductsDeliveryEventInput).

Response

Returns an EventOutput

Arguments
Name Description
data - ProductsDeliveryEventInput!

Example

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

eventInvoiceProductsReception

Description

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

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

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

Response

Returns an EventOutput

Arguments
Name Description
data - ProductsReceptionEventInput!

Example

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

eventInvoiceReceiptAck

Description

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

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

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

Response

Returns an EventOutput

Arguments
Name Description
data - AckEventInput!

Example

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

eventInvoiceRejection

Description

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

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

Response

Returns an EventOutput

Arguments
Name Description
data - InvoiceRejectionEventInput!

Example

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

eventInvoiceTacitAcceptance

Description

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

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

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

Response

Returns an EventOutput

Arguments
Name Description
data - TacitAcceptanceEventInput!

Example

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

updateDianResolutions

Description

Updates the DIAN resolutions.

Downloads and saves the resolutions registered in the DIAN systems

Response

Returns a DianResolutionDataOutput

Example

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

updateInvoicerData

Description

Updates the Invoicer data.

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

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

Returns a Client

Arguments
Name Description
data - InvoicerDataInput!

Example

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

voidAcquisitionSupportDocument

Description

Void one Support Document.

Voids the Aquisition Support Document (AcquisitionSupportDocumentInput).

Response

Returns an AcquisitionAdjustmentNoteOutput

Arguments
Name Description
document - AcquisitionSupportDocumentVoidInput!

Example

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

voidInvoice

Description

Void an Invoice.

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

Response

Returns a CreditNoteDocumentOutput

Arguments
Name Description
document - VoidInvoiceInput!

Example

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

Types

AccountStatement

Description

Defines the response object for a business Unit type

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

AccountStatementConnection

Description

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

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

AccountStatementEdge

Description

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

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

AccountStatementInput

Description

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

Fields
Input Field Description
credits - Int

The amount of credits.

  • Mandatory: required
notifications - String

Notifications about plan.

  • Mandatory: optional
organizationUuid - UID

The uuid of the organization

  • Mandatory: required
organizationalUnitUuid - UID

The uuid of the organizational unit

  • Mandatory: required
planName - String

The name of the plan

  • Mandatory: required
planSpecificationEmission - EmissionDataInput

Structure for an Emission data.

  • Mandatory: required
planSpecificationReception - ReceptionDataInput

Structure for the Organization's unit contact details.

  • Mandatory: required
productSpecification - json

The Version of the product when the purchase was made

  • Mandatory: optional
productUuid - String

The Uuid of the product

  • Mandatory: optional
productVersion - Int

The Version of the product when the purchase was made

  • Mandatory: optional
purchaseDate - Date

The date the plan was purchased

  • Mandatory: required
validityDateEnd - Date

The date the plan end its validity

  • Mandatory: required
validityDateStart - Date

The date the plan start its validity

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

AccountStatementOrderInput

Description

Code to identify the type of account statement ordering

Values
Enum Value Description

ACCOUNT_STATEMENT_ID_ASC

Sort by account statement id in ascending order.

ACCOUNT_STATEMENT_ID_DESC

Sort by account statement id in descending order.

INSERTED_AT_ASC

Sort by inserted at in ascending order.

INSERTED_AT_DESC

Sort by inserted at in descending order.

PLAN_NAME_ASC

Sort by plan name in ascending order.

PLAN_NAME_DESC

Sort by plan name in descending order.

PURCHASE_AT_ASC

Sort by purchase at in ascending order.

PURCHASE_AT_DESC

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

AccountStatementOutput

Description

Structure for an account statement output

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

AccountStatementQueryInput

Description

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

Fields
Input Field Description
and - [AccountStatementQueryOptionsInput]

List of filters where all must happen.

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

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

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

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

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

List of filters where none must happen.

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

List of filters where only one has to happen.

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

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

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

AccountStatementQueryOptionsInput

Description

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

Fields
Input Field Description
id - String

The id of the organization.

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

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

  • Mandatory: optional
purchaseDate - Date

Code that identify each Colombian township.

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

The name of the township.

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

The name of the township.

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

AccountStatementQuerySearchInput

Description

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

Fields
Input Field Description
name - AccountStatementSearchInput

Query options for organization unit text search statements.

  • Mandatory: optional
value - String

Value to be assigned to this search.

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

AccountStatementSearchInput

Description

Query options for account statement search statements

Values
Enum Value Description

ID

Text search by ID

PLAN_NAME

Text search by plan name
Example
"ID"

AccountingCustomerParty

Description

Group with information defining the Acquirer or buyer

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

AccountingCustomerPartyInput

Description

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

Fields
Input Field Description
additionalAccountId - PersonType!

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

  • Mandatory: required
contact - ContactInput

The primary contact for this party.

  • Mandatory: optional
customerAssignedAccountId - String

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

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

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

  • Mandatory: optional
industryClassificationCode - OrgEconomicActivitiesInput

The party's economic activities.

  • Mandatory: optional
partyTaxScheme - PartyTaxSchemeInput

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

  • Mandatory: optional
personId - PersonIdInput!

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

  • Mandatory: required
personName - PersonNameInput!

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

Example values:

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

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

  • Mandatory: optional
supplierAssignedAccountId - String

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

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

AccountingSupplierParty

Description

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

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

AccountingSupplierPartyInput

Description

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

Fields
Input Field Description
additionalAccountId - PersonType!

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

  • Mandatory: required
contact - ContactInput

The primary contact for this party.

  • Mandatory: optional
customerAssignedAccountId - String

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

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

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

  • Mandatory: optional
industryClassificationCode - OrgEconomicActivitiesInput

The party's economic activities.

  • Mandatory: optional
partyTaxScheme - PartyTaxSchemeInput!

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

  • Mandatory: optional
personId - PersonIdInput!

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

  • Mandatory: required
personName - PersonNameInput!

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

Example values:

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

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

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

AckEventInput

Description

Ack Of receipt of the invoice.

Fields
Input Field Description
eventNotes - [NoteField]

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

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

The unique identifier of an Event.

  • Mandatory: required
issueDate - DateTime!

Date and time of the event issuance

  • Mandatory: required
issuerParty - EventPartyInput!

Description of the person/entity who received the event

  • Mandatory: required
purchaseInvoiceUid - UID!

The unique identifier of an already imported Purchase Invoice.

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

AcquisitionAdjustmentNoteDocument

Description

Defines the response object for a Acquisition Adjustment Notes

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

AcquisitionAdjustmentNoteDocumentConnection

Description

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

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

AcquisitionAdjustmentNoteDocumentEdge

Description

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

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

AcquisitionAdjustmentNoteDocumentNode

Description

Defines the response object for a Acquisition Adjustment Notes

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

AcquisitionAdjustmentNoteGeneralInformationInput

Description

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

Fields
Input Field Description
acquirerEmail - email

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

  • Mandatory: optional
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - AcquisitionAdjustmentNoteOperationType!

The Acquirer Support Document's operation.

  • Mandatory: required
reasonOfIssuance - LocalizedStringInput!

The Debit Note's reason of issuance.

  • Mandatory: required
subtypeCode - AcquisitionAdjustmentNoteSubtype!

The Acquirer Support Document's subtype.

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

AcquisitionAdjustmentNoteInput

Description

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

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

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

Input where discount's or charges are found.

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

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

  • Mandatory: required
generalInformation - AcquisitionAdjustmentNoteGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

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

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

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

Document's Payment Description.

  • Mandatory: required
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document

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

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

  • Mandatory: required
taxDescription - [TaxTotalInput]

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

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

The total amount of tax.

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

AcquisitionAdjustmentNoteOperationType

Description

Type of operation

Values
Enum Value Description

PARTIAL_OR_TOTAL_DISCOUNT

Partial or total discount of the document

PARTIAL_REFUND

Partial refund of one or more products

PRICE_ADJUSTMENT

Price adjustment over one or moreproducts
Example
"PARTIAL_OR_TOTAL_DISCOUNT"

AcquisitionAdjustmentNoteOutput

Description

Structure for a document output

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

AcquisitionAdjustmentNoteQueryInput

Description

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

Fields
Input Field Description
and - [AcquisitionAdjustmentNoteQueryOptionsInput]

List of filters where all must happen.

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

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

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

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

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

List of filters where none must happen.

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

List of filters where only one has to happen.

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

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

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

AcquisitionAdjustmentNoteQueryOptionsInput

Description

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

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

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

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

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

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

Date on which the document was sent to DIAN.

  • Mandatory: optional
operationCode - AcquisitionAdjustmentNoteOperationType

The Invoice's operation.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

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

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

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

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

First name of the person assigned on the document.

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

The identifier of the person assigned on the document.

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

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

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

Seecond sur name of the person assigned on the document.

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

The Invoice's subtype.

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

AcquisitionAdjustmentNoteSubtype

Description

Acquisition adjustment note subtypes

Values
Enum Value Description

ADJUSTMENT_NOTE

Standard Adjustment Note
Example
"ADJUSTMENT_NOTE"

AcquisitionDocumentSummary

Description

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

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

AcquisitionSupportDocument

Description

Defines the response object for a Support Document

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

AcquisitionSupportDocumentConnection

Description

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

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

AcquisitionSupportDocumentEdge

Description

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

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

AcquisitionSupportDocumentGeneralInformation

Description

Acquisition Support Document's General Information

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

AcquisitionSupportDocumentGeneralInformationInput

Description

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

Fields
Input Field Description
acquirerEmail - email

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

  • Mandatory: optional
currency - CurrencyCode!

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

  • Mandatory: required
issueDateTime - DateTime!

Date and Time of Issuance.

  • Mandatory: required
operationCode - AcquisitionSupportDocumentOperationType!

The Acquirer Support Document's operation.

  • Mandatory: required
subtypeCode - AcquisitionSupportDocumentSubtype!

The Acquirer Support Document's subtype.

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

AcquisitionSupportDocumentInput

Description

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

Fields
Input Field Description
documentLines - [DocumentLineInput!]!

Input with information concerning products within the document.

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

Input where discount's or charges are found.

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

Parties involved in the document.

  • Mandatory: required
documentTotals - LegalMonetaryTotalInput!

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

  • Mandatory: required
generalInformation - AcquisitionSupportDocumentGeneralInformationInput!

Document's general information.

  • Mandatory: required
id - DocumentConsecutiveInput!

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

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

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

Organizational Unit's Id.

  • Mandatory: required
paymentDescription - DocumentPaymentDescriptorInput!

Document's Payment Description.

  • Mandatory: required
referencedDocuments - [DocumentReferenceInput]

Additional Documents referenced inside the document

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

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

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

The total amount of tax.

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

AcquisitionSupportDocumentNode

Description

Defines the response object for a Support Document

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

AcquisitionSupportDocumentOperationType

Description

Type of operation

Values
Enum Value Description

NON_RESIDENT_PURCHASE

Purchase to a non-resident in the country

RESIDENT_PURCHASE

Purchase to a resident in the country
Example
"NON_RESIDENT_PURCHASE"

AcquisitionSupportDocumentOutput

Description

Structure for a document output

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

AcquisitionSupportDocumentQueryInput

Description

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

Fields
Input Field Description
and - [AcquisitionSupportDocumentQueryOptionsInput]

List of filters where all must happen.

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

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

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

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

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

List of filters where none must happen.

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

List of filters where only one has to happen.

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

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

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

AcquisitionSupportDocumentQueryOptionsInput

Description

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

Fields
Input Field Description
creationDate - Date

Document creation date in the system.

  • Mandatory: optional
currency - CurrencyCode

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

  • Mandatory: optional
dateRange - DateRangeInput

Date range for document search.

  • Mandatory: optional
documentUid - UID

This is the document's UUID in YabiCo.

  • Mandatory: optional
id - String

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

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

Date on which the document was sent to DIAN.

  • Mandatory: optional
organizationalUnitId - UID

UID of the organizational unit.

  • Mandatory: optional
personCompStringName - String

The company name of the person assigned on the document.

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

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

  • Mandatory: optional
personFirstSurname - String

First sur name of the person assigned on the document.

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

First name of the person assigned on the document.

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

The identifier of the person assigned on the document.

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

Type of person ID.

  • Mandatory: optional
personSecondName - String

Middle name of the person assigned on the document.

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

Seecond sur name of the person assigned on the document.

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

AcquisitionSupportDocumentSubtype

Description

Acquisition support document subtypes

Values
Enum Value Description

REGULAR_PURCHASE

A regular Acquisition Support Document
Example
"REGULAR_PURCHASE"

AcquisitionSupportDocumentVoidInput

Description

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

Fields
Input Field Description
acquisitionSupportDocumentToVoid - AcquisitionSupportIdInput!

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

  • Mandatory: required
id - DocumentConsecutiveInput!

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

  • Mandatory: required
issuerSoftwareSystem - IssuerSoftwareSystem

Additional information to inform the software system issuing the document.

  • Mandatory: optional
notes - [DocumentNotes]

Additional information: Free text, related to the document.

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

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

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

AcquisitionSupportIdInput

Description

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

Fields
Input Field Description
id - DocumentConsecutiveInput

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

  • Mandatory: optional
uid - UID

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

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

AdditionalAccountId

Description

Defines the response object for the additional account ID

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

AllowanceCharge

Description

Structure for the allowance charge

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

AllowanceChargeInput

Description

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

Fields
Input Field Description
amount - decimal!

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

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

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

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

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

  • Mandatory: required
percentage - Float

Used for percentaged discounts/charges.

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

The reason for this allowance or charge.

  • Mandatory: required
reasonCode - LineModifierCode

A code signifying the reason for this allowance or charge.

  • Mandatory: optional
Example