Sales | Invoice

The Invoice end point is used to record a commercial document from a sale of goods or services. This document in Portugal will be communicated to AT.

Overview

URL	api/{tenantKey}/{orgKey}/billing/invoices
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Invoices
  • GET Invoices (paged)
  • GET Invoice by identifier
  • GET Invoice by key
  • GET Print Invoice by identifier
  • GET Print Invoice by key
  • GET Original Print InvoiceOriginal by identifier
  • GET Original Print Invoice by key
• POST:
  • POST Invoices
  • POST To Return Order
  • POST Generate Cius
• PUT:
  • PUT Set Custom Attribute Invoice
  • PUT Set Custom Attribute InvoiceLine
  • PUT Set IsActive Invoice
  • PUT Set FinancialAccount Invoice
  • PUT Set PaymentMethod Invoice
  • PUT Set Remarks Invoice
  • PUT Set Note Invoice
  • PUT Set NoteToRecipient Invoice
  • PUT Set SalesChannel Invoice
  • PUT Set IsManualSerie Invoice
  • PUT Set IsOneTimeCustomer Invoice
  • PUT Set IsSimpleInvoice Invoice
  • PUT Set FiscalDocumentType Invoice
  • PUT Set AccountingSchema Invoice
  • PUT Set PartyAccountingSchema Invoice
  • PUT Set IsWsCommunicable Invoice
  • PUT Set Notification Invoice
  • PUT Set EmailTo Invoice
  • PUT Set DimensionSet Invoice
  • PUT Set CustomerAccount Invoice
  • PUT Set PaymentReference Invoice
  • PUT Set DimensionSetJson Invoice
  • PUT Set CustomsDeclaration Invoice
  • PUT Set IsCommunicated Invoice
  • PUT Set PrintDate Invoice
  • PUT Set LogisticsPartyId Invoice
  • PUT Set IsAgregatedDocument Invoice
  • PUT Set Swift Invoice
  • PUT Set IBAN Invoice
  • PUT Set PaymentInstruction Invoice
  • PUT Set OriginalTaxExclusiveAmount Invoice
  • PUT Set OriginalTaxAmount Invoice
  • PUT Set PrintedReportName Invoice
  • PUT Set IsSeriesCommunicated Invoice
  • PUT Set DimensionSet InvoiceLine
  • PUT Set SalesAccount InvoiceLine
  • PUT Set DiscountAccount InvoiceLine
  • PUT Set ChartOfAccount InvoiceLine
  • PUT Set DimensionSetJson InvoiceLine
  • PUT Set SourceOrder InvoiceLine
  • PUT Set SourceOrderId InvoiceLine
  • PUT Set SourceOrderLine InvoiceLine
  • PUT Set SourceOrderLineId InvoiceLine
  • PUT Set SourceOrderSchemaEntityId InvoiceLine
  • PUT Set CommitmentReference InvoiceLine
  • PUT Set RoundingTaxableAmount InvoiceTax
  • PUT Set RoundingTaxAmount InvoiceTax
  • PUT Set TotalTaxableAmount InvoiceTax
  • PUT Set TotalTaxAmount InvoiceTax
• DELETE:
  • DELETE Invoice by identifier
  • DELETE Invoice by key

All Resources

This service uses the following resources:

• ApiInvoiceDocumentLinesDocumentLineTaxesResource
• ApiInvoiceDocumentLinesResource
• ApiInvoiceDocumentTaxesResource
• ApiInvoiceResource
• InvoiceLineResource
• InvoiceLineTaxResource
• InvoiceResource
• InvoiceReturnOrderLine
• InvoiceTaxResource
• MoneyResource
• StandardInvoiceDocumentLinesResource
• StandardInvoiceResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AccountingSchema
• DocumentLineStatus
• DocumentStatus
• ItemType

GET Operations

GET Invoices

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See InvoiceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Invoices (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See InvoiceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Invoice by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See InvoiceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Invoice by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

Response:

When successful, the response body contains the entity record. See InvoiceResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Print Invoice by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print Invoice by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Original Print InvoiceOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print Invoice by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST Invoices

Creates a new entity record.

The following elements are required:

invoiceResource

(ApiInvoiceResource) The request body should contain the entity record that should be created. See ApiInvoiceResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiInvoiceResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST To Return Order

This operation is used to create a return order based on a invoice.

The following elements are required:

invoiceReturnOrder

(InvoiceReturnOrder) The Invoice Return Order.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST Generate Cius

Generate CIUS-PT document file.

The following elements are required:

invoiceId

(Guid) The Invoice Identifier.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Resource URL:

PUT Operations

PUT Set AccountingSchema Invoice

Updates the value of attribute 'AccountingSchema' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ChartOfAccount InvoiceLine

Updates the value of attribute 'ChartOfAccount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CommitmentReference InvoiceLine

Updates the value of attribute 'CommitmentReference' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CustomerAccount Invoice

Updates the value of attribute 'CustomerAccount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CustomsDeclaration Invoice

Updates the value of attribute 'CustomsDeclaration' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSet Invoice

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSet InvoiceLine

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSetJson Invoice

Updates the value of attribute 'DimensionSetJson' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSetJson InvoiceLine

Updates the value of attribute 'DimensionSetJson' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DiscountAccount InvoiceLine

Updates the value of attribute 'DiscountAccount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set EmailTo Invoice

Updates the value of attribute 'EmailTo' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set FinancialAccount Invoice

Updates the value of attribute 'FinancialAccount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set FiscalDocumentType Invoice

Updates the value of attribute 'FiscalDocumentType' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IBAN Invoice

Updates the value of attribute 'IBAN' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive Invoice

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsAgregatedDocument Invoice

Updates the value of attribute 'IsAgregatedDocument' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsCommunicated Invoice

Updates the value of attribute 'IsCommunicated' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsManualSerie Invoice

Updates the value of attribute 'IsManualSerie' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsOneTimeCustomer Invoice

Updates the value of attribute 'IsOneTimeCustomer' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsSeriesCommunicated Invoice

Updates the value of attribute 'IsSeriesCommunicated' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsSimpleInvoice Invoice

Updates the value of attribute 'IsSimpleInvoice' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsWsCommunicable Invoice

Updates the value of attribute 'IsWsCommunicable' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LogisticsPartyId Invoice

Updates the value of attribute 'LogisticsPartyId' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Note Invoice

Updates the value of attribute 'Note' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set NoteToRecipient Invoice

Updates the value of attribute 'NoteToRecipient' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Notification Invoice

Updates the value of attribute 'Notification' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set OriginalTaxAmount Invoice

Updates the value of attribute 'OriginalTaxAmount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set OriginalTaxExclusiveAmount Invoice

Updates the value of attribute 'OriginalTaxExclusiveAmount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PartyAccountingSchema Invoice

Updates the value of attribute 'PartyAccountingSchema' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PaymentInstruction Invoice

Updates the value of attribute 'PaymentInstruction' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PaymentMethod Invoice

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PaymentReference Invoice

Updates the value of attribute 'PaymentReference' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PrintDate Invoice

Updates the value of attribute 'PrintDate' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PrintedReportName Invoice

Updates the value of attribute 'PrintedReportName' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Remarks Invoice

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set RoundingTaxableAmount InvoiceTax

Updates the value of attribute 'RoundingTaxableAmount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set RoundingTaxAmount InvoiceTax

Updates the value of attribute 'RoundingTaxAmount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SalesAccount InvoiceLine

Updates the value of attribute 'SalesAccount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SalesChannel Invoice

Updates the value of attribute 'SalesChannel' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrder InvoiceLine

Updates the value of attribute 'SourceOrder' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderId InvoiceLine

Updates the value of attribute 'SourceOrderId' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderLine InvoiceLine

Updates the value of attribute 'SourceOrderLine' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderLineId InvoiceLine

Updates the value of attribute 'SourceOrderLineId' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderSchemaEntityId InvoiceLine

Updates the value of attribute 'SourceOrderSchemaEntityId' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Swift Invoice

Updates the value of attribute 'Swift' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set TotalTaxableAmount InvoiceTax

Updates the value of attribute 'TotalTaxableAmount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set TotalTaxAmount InvoiceTax

Updates the value of attribute 'TotalTaxAmount' in the specified entity record.

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Custom Attribute Invoice

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set Custom Attribute InvoiceLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE Invoice by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Invoice by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiInvoiceDocumentLinesDocumentLineTaxesResource

The following elements are required:

roundingTaxableAmount	(MoneyResource) The rounding amount of revenue subject to tax. Internally determined. See MoneyResource .
roundingTaxAmount	(MoneyResource) The invoice line rounding tax amount. Internally determined. See MoneyResource .

ApiInvoiceDocumentLinesResource

The following elements are required:

salesItem	(string) The sales item representing the good or service to be invoiced.
description	(string) The invoice's line item description. The default is defined on the sales item.
quantity	(decimal) The invoice's line item quantity. The default 1.
unitPrice	(MoneyResource) The invoice's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit. See MoneyResource .
unit	(string) The invoice's line item sales unit. The default sales unit is defined on the sales item.
itemTaxSchema	(string) The invoice's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
partyTaxSchema	(string) The invoice's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
deliveryDate	(DateTime) The expected line's item delivery date. The default is the document date.
salesAccount	(string) The revenue GL account assigned from the account determination in the invoice tye.
chartOfAccount	(string) The chart of accounts infered from company financial setup.

The following elements are optional:

warehouse	(string) The invoice's line item warehouse. The default is defined on the materials item.
itemWithholdingTaxSchema	(string) The invoice's line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the sales item.
discount1	(decimal) The line's item discount 1 percentage. The default is 0.
discount2	(decimal) The line's item discount 2 percentage. The default is 0.
discount3	(decimal) The line's item discount 3 percentage. The default is 0.
complementaryDescription	(string) The invoice's line item complementary description. The default is defined on the sales item.
documentLineStatus	(enum DocumentLineStatus) The invoice's line status. The default is Open. See DocumentLineStatus.
documentLineTaxes	(List of ApiInvoiceDocumentLinesDocumentLineTaxesResource) The invoice's line taxes. See ApiInvoiceDocumentLinesDocumentLineTaxesResource.
dimensionSet	(string) The dimension set. Infered from the dimension combination in the invoice type.
discountAccount	(string) The commercial discount GL account assigned from the account determination in the invoice tye.
dimensionSetJson	(string) Dimension Set Json.
sourceOrder	(string) The order that origin this line.
sourceOrderId	(Guid) The order id that origin this line.
sourceOrderLine	(int) The order line index that origin this line.
sourceOrderLineId	(Guid) The order line id that origin this line.
sourceOrderSchemaEntityId	(Guid) The order schema id that origin this line.
commitmentReference	(string) The state supplier commitment reference.

ApiInvoiceDocumentTaxesResource

The following elements are required:

roundingTaxableAmount	(MoneyResource) The rounding value of the invoice amount of revenue subject to tax. See MoneyResource .
roundingTaxAmount	(MoneyResource) The rounding value of the invoice tax amount. Internally determined. See MoneyResource .
totalTaxableAmount	(MoneyResource) The total amount of revenue subject to tax. See MoneyResource .
totalTaxAmount	(MoneyResource) The total invoice tax amount. Internally determined. See MoneyResource .

The following elements are optional:

customExemptionReasonCode

(string) Indicates the invoice tax schema custom exemption reason. Applicable only if the tax schema is exempt. Internally determined.

ApiInvoiceResource

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
company	(string) The company where the invoice is posted. The company code is the central organizational unit within the system.
paymentTerm	(string) The invoice's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
paymentMethod	(string) The invoice's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
currency	(string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created.
buyerCustomerPartyName	(string) The customer's name. It is inferred from the customer party.
accountingParty	(string) The customer designated in the invoice as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party.
exchangeRate	(decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
loadingCountry	(string) The country of the physical location where the goods are loaded. The default is the company country.
unloadingCountry	(string) The physical location address country where the goods are unloaded. The default is customer address country.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
isSimpleInvoice	(bool) Defines if the invoice type is defined as simple invoice type. Internally determined.
isWsCommunicable	(bool) Indicates if the invoice is communicated via web service to fiscal authority. Inferred from the invoice type serie.
customerAccount	(string) The customer GL account.
isCommunicated	(bool) Flag to know if it is communicated to AT.
printDate	(DateTime) The date when the document was printed.
buyerCustomerParty	(string) The customer party. Party that the invoice is for.
isAgregatedDocument	(bool) Defines if the invoice has agregated document. Used by saft import.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

economicActivityClassification	(string) The invoice's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
cashFlowItem	(string) The incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows.
financialAccount	(string) An account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts.
deliveryTerm	(string) The invoice's delivery term. The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party.
buyerCustomerPartyTaxId	(string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the customer party.
buyerCustomerPartyAddress	(string) The customer's address. It is inferred from the customer party.
accountingPartyName	(string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId	(string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress	(string) The accounting's customer address. It is inferred from the accounting party.
exchangeRateDate	(DateTime) The exchange rate creation date.
remarks	(string) The invoice’s remarks.
note	(string) The document's note.
priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup.
noteToRecipient	(string) The note to the invoice recipient.
settlementDiscountPercent	(decimal) Obsolete.
altAddress	(string) The alternative customer's address key to be used on the invoice. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values.
loadingPoint	(string) The physical location where the goods are loaded. The default is the company physical location.
loadingStreetName	(string) The street name of the physical location where the goods are loaded. The default is the company physical location.
loadingBuildingNumber	(string) The building number of the physical location where the goods are loaded. The default is the company physical location.
loadingPostalZone	(string) The postal zone of the physical location where the goods are loaded. The default is the company physical location.
loadingCityName	(string) The city of the physical location where the goods are loaded. The default is the company physical location.
loadingDateTime	(DateTimeOffset) The goods loading date and time from the loading physical location. The default is the invoice creation date and time.
loadingPointAddress	(string) The physical location address where the goods are loaded. The default is the company physical location address.
loadingWarehouse	(string) The loading warehouse. When defined the warehouse address will replace the loading address values.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is customer address.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
unloadingBuildingNumber	(string) The building number of the physical location where the goods are unloaded. The default is customer address building number.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingPointAddress	(string) The physical location address where the goods are unloaded. The default is customer address.
unloadingDateTime	(DateTimeOffset) The goods unloading date and time on the unloading physical location.
vehiclePlateNumber	(string) The vehicle's plate used to trasnport the goods.
hash	(string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl	(string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
manualNumber	(int) The invoice's manual serie number. Applicable only when the invoice type series is defined as manual.
manualDate	(DateTime) The invoice's manual date. Applicable only when the invoice type series is defined as manual.
manualSerie	(string) The invoice's manual serie. Applicable only when the invoice type series is defined as manual.
documentLines	(List of ApiInvoiceDocumentLinesResource) The invoice's lines. See ApiInvoiceDocumentLinesResource.
documentTaxes	(List of ApiInvoiceDocumentTaxesResource) The invoice's taxes. See ApiInvoiceDocumentTaxesResource.
salesChannel	(string) The invoice's sales channel origin. The default value is defined in the sales setup configuration settings.
dueDate	(DateTime) Date in which the payment is due. In some countries it is also known as law date.
isManualSerie	(bool) Defines if the invoice type series is defined as manual. Internally determined.
fiscalDocumentType	(string) The legal fiscal document type defined on the invoice type. Inferred from the invoice type.
accountingAltAddress	(string) The alternative accounting's party address key to be used on the invoice. The alternative addresses keys are defined on the accounting party addresses. When defined overrides the accounting party address values.
accountingSchema	(enum AccountingSchema) The accounting's organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
partyAccountingSchema	(enum AccountingSchema) The customer's accounting organization method. The customer organication can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
notification	(string) The invoice's notification configuration. Inferred from the invoice type.
emailTo	(string) The email(s) to send invoice notification. Inferred from the notification.
dimensionSet	(string) The dimension set. Infered from the customer.
deliveryMode	(string) The delivery mode. (ex: mail).
paymentReference	(string) The payment reference.
dimensionSetJson	(string) Dimension Set Json.
customsDeclaration	(string) The customs declaration.
salesperson	(string) The sales person. The seller of the invoice.
logisticsPartyId	(Guid) The party's unique identifier. It is inferred from the party. Internally setted.
swift	(string) he society for Worldwide Interbank Financial Telecommunication number.
iBAN	(string) The financial account's International Bank Account Number.
paymentInstruction	(string) The Payment authorization given by the party.
originalTaxExclusiveAmount	(decimal) [Non persisted] The invoice's original total net value. Total value of goods and services after discounts, excluding taxes. Only applicable to external invoices import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
originalTaxAmount	(decimal) [Non persisted] The invoice's original total tax value of goods and services. Only applicable to external invoices import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
printedReportName	(string) Indicates the report name used to print the document. Internally determined.

InvoiceLineResource

The following elements are required:

salesItem	(string) The sales item representing the good or service to be invoiced.
description	(string) The invoice's line item description. The default is defined on the sales item.
quantity	(decimal) The invoice's line item quantity. The default 1.
unitPrice	(MoneyResource) The invoice's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit. See MoneyResource .
unit	(string) The invoice's line item sales unit. The default sales unit is defined on the sales item.
itemTaxSchema	(string) The invoice's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
partyTaxSchema	(string) The invoice's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
deliveryDate	(DateTime) The expected line's item delivery date. The default is the document date.
taxTotal	(MoneyResource) The total’s amount of taxes for this line. Internally calculated. See MoneyResource .
allowanceChargeAmount	(MoneyResource) The invoice’s line total discount. Internally calculated. See MoneyResource .
taxExclusiveAmount	(MoneyResource) The invoice's line net value. The line value after discounts, excluding taxes. Internally calculated. See MoneyResource .
grossValue	(MoneyResource) The invoice's line value before taxes or discounts. Internally calculated. See MoneyResource .
lineExtensionAmount	(MoneyResource) The invoice's line payable amount. The line value including taxes and discounts. Internally calculated. See MoneyResource .
currency	(string) The money’s unit. Inferred from the invoice currency.
itemType	(enum ItemType) The invoice's line item type. Inferred from the sales item type. Internally determined. See ItemType.
salesAccount	(string) The revenue GL account assigned from the account determination in the invoice tye.
chartOfAccount	(string) The chart of accounts infered from company financial setup.
deliveryOnInvoice	(bool) The default delivery type when the orders are processed.

The following elements are optional:

warehouse	(string) The invoice's line item warehouse. The default is defined on the materials item.
itemWithholdingTaxSchema	(string) The invoice's line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the sales item.
partyWithholdingTaxSchema	(string) The invoice's customer party withholding tax schema. The withholding tax schema identifies the group of withholding taxes a party is liable for. The withholding tax schema is defined in the customer party.
discount1	(decimal) The line's item discount 1 percentage. The default is 0.
discount2	(decimal) The line's item discount 2 percentage. The default is 0.
discount3	(decimal) The line's item discount 3 percentage. The default is 0.
complementaryDescription	(string) The invoice's line item complementary description. The default is defined on the sales item.
documentLineStatus	(enum DocumentLineStatus) The invoice's line status. The default is Open. See DocumentLineStatus.
documentLineTaxes	(List of InvoiceLineTaxResource) The invoice's line taxes. See InvoiceLineTaxResource.
sourceSchemaEntity	(string) The schema’s entity from originating document, possible values: Orders, Deliveries, GoodsReturns.
sourceDoc	(string) The source document using the format {..} when the invoice is transformed from another document. Internally determined.
sourceDocId	(Guid) The source document identifier when the invoice is transformed from other source document. Internally determined.
sourceDocLine	(int) The source document's line number, when the invoice was transformed. Internally determined.
sourceDocLineId	(Guid) The source document's line identifier, when the invoice was transformed. Internally determined.
billingRequestId	(Guid) The billing request's identifier that originated the invoice line, when the invoice is transformed. Internally determined.
billingRequestLineId	(Guid) The billing request's line id that originated the invoice line, when the invoice is transformed. Internally determined.
dimensionSet	(string) The dimension set. Infered from the dimension combination in the invoice type.
discountAccount	(string) The commercial discount GL account assigned from the account determination in the invoice tye.
dimensionSetJson	(string) Dimension Set Json.
printAllDiscounts	(string) The line all discounts.
printTaxCodes	(string) The line tax codes.
sourceOrder	(string) The order that origin this line.
sourceOrderId	(Guid) The order id that origin this line.
sourceOrderLine	(int) The order line index that origin this line.
sourceOrderLineId	(Guid) The order line id that origin this line.
sourceOrderSchemaEntityId	(Guid) The order schema id that origin this line.
commitmentReference	(string) The state supplier commitment reference.

InvoiceLineTaxResource

The following elements are required:

isExempt	(bool) Indicates whether the invoice line tax schema is exempt. Internally determined.
taxableAmount	(MoneyResource) The invoice's line revenue amount subject to tax. This taxable amount is calculated by subtracting the corresponding discounts and allowance charges to the gross value. Internally determined. See MoneyResource .
taxPercentage	(decimal) The invoice's line tax rate percentage. Internally determined.
taxAmount	(MoneyResource) The invoice's line tax amount. Internally determined. See MoneyResource .
taxTypeCode	(string) The invoice's line tax type code. Internally determined.
currency	(string) The money's unit. Inferred from the invoice currency. Internally determined.
roundingTaxableAmount	(MoneyResource) The rounding amount of revenue subject to tax. Internally determined. See MoneyResource .
roundingTaxAmount	(MoneyResource) The invoice line rounding tax amount. Internally determined. See MoneyResource .

The following elements are optional:

exemptionReasonCode

(string) Indicates the invoice line tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.

InvoiceResource

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings. (fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type. (fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
company	(string) The company where the invoice is posted. The company code is the central organizational unit within the system. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
paymentTerm	(string) The invoice's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
paymentMethod	(string) The invoice's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
currency	(string) The money's unit used by the document. This value is important for currency exchanges or to set the number of decimal places used to represent values. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
documentDate	(DateTime) The date when the document is issued.
postingDate	(DateTime) The date when the document is created.
buyerCustomerPartyName	(string) The customer's name. It is inferred from the customer party.
accountingParty	(string) The customer designated in the invoice as the party to whom the invoice should be sent for payment. It may or may not be the party to whom the goods or services are delivered. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
exchangeRate	(decimal) The rate that translates the values in the document from the document currency to company base currency. By default the system uses the exchange rates table at the document date.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
cashInvoice	(bool) Indicates whether the invoice is a cash invoice or not. Defined internally and inferred from the invoice type.
grossValue	(MoneyResource) The total’s value of goods and services before taxes or discounts. Internally calculated. See MoneyResource .
allowanceChargeAmount	(MoneyResource) The total’s discount over goods and services. Internally calculated. See MoneyResource .
taxExclusiveAmount	(MoneyResource) The invoice's total net value. Total value of goods and services after discounts, excluding taxes. Internally calculated. See MoneyResource .
taxTotal	(MoneyResource) The total’s tax value of goods and services. Internally calculated. See MoneyResource .
payableAmount	(MoneyResource) The invoice's payable amount. Total value of goods and services including taxes and discounts. Internally calculated. See MoneyResource .
wTaxTotal	(MoneyResource) The total’s withholding tax value of goods and services. Internally calculated. See MoneyResource .
totalLiability	(MoneyResource) The document’s total liability. The payable amount without withholding taxes. See MoneyResource .
loadingCountry	(string) The country of the physical location where the goods are loaded. The default is the company country. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
unloadingCountry	(string) The physical location address country where the goods are unloaded. The default is customer address country. (fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
isTransformed	(bool) Defines if the invoice was transformed from the other document. Internally determined.
isExternal	(bool) Defines if the invoice type series is defined as external. Internally determined.
isManual	(bool) Defines if the invoice type series is defined as manual. Internally determined.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
isSimpleInvoice	(bool) Defines if the invoice type is defined as simple invoice type. Internally determined.
isWsCommunicable	(bool) Indicates if the invoice is communicated via web service to fiscal authority. Inferred from the invoice type serie.
customerAccount	(string) The customer GL account. (fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service.
journalNumber	(int) The journal number assigned in accounting.
isCommunicated	(bool) Flag to know if it is communicated to AT.
printDate	(DateTime) The date when the document was printed.
buyerCustomerParty	(string) The customer party. Party that the invoice is for. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
isAgregatedDocument	(bool) Defines if the invoice has agregated document. Used by saft import.
roundingTaxableAmount	(MoneyResource) Rounding. See MoneyResource .
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

economicActivityClassification	(string) The invoice's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity. (fk) Allowed value: the natural key of a record of type EconomicActivityClassification. These records are accessibly through the EconomicActivityClassifications service.
cashFlowItem	(string) The incoming and outgoing cash flow caused by the main business activities. The component of the cash flow operations shows how much money is generated by a company's products or services. Generally, the changes made to the cash, banks, accounts receivables and accounts payable affects operational cash. The classification of each of these operations' types is made by using cash flows. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
financialAccount	(string) An account that exists in a financial institution. The financial institution holds someone's money, resulting in a positive balance. It can also be a credit or loans account in which the bank lends money, resulting in a negative balance or debit. Unlike a brokerage account, which allows the investor to buy and sell stocks, a bank account is used for savings. The types of bank accounts include savings accounts and current accounts. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
deliveryTerm	(string) The invoice's delivery term. The conditions in a sales or transportation contract that specify the means of transportation. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
taxIncluded	(bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the invoice series.
buyerCustomerPartyTaxId	(string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the customer party.
buyerCustomerPartyAddress	(string) The customer's address. It is inferred from the customer party.
accountingPartyName	(string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId	(string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress	(string) The accounting's customer address. It is inferred from the accounting party.
exchangeRateDate	(DateTime) The exchange rate creation date.
remarks	(string) The invoice’s remarks.
note	(string) The document's note.
priceList	(string) The catalogued table values that sets the standard price for the products and goods traded by a specific entity. The default is inferred from the customer party if defined, otherwise from the sales setup. (fk) Allowed value: the natural key of a record of type PriceList. These records are accessibly through the PriceLists service.
noteToRecipient	(string) The note to the invoice recipient.
isPrinted	(bool) Indicates if the invoice has been printed. Internally determined.
settlementDiscountPercent	(decimal) Obsolete.
altAddress	(string) The alternative customer's address key to be used on the invoice. The alternative addresses keys are defined on the customer party addresses. When defined overrides the customer party address and unloading address values. (fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
documentStatus	(enum DocumentStatus) The document's status. Internally determined. See DocumentStatus.
loadingPoint	(string) The physical location where the goods are loaded. The default is the company physical location.
loadingStreetName	(string) The street name of the physical location where the goods are loaded. The default is the company physical location.
loadingBuildingNumber	(string) The building number of the physical location where the goods are loaded. The default is the company physical location.
loadingPostalZone	(string) The postal zone of the physical location where the goods are loaded. The default is the company physical location.
loadingCityName	(string) The city of the physical location where the goods are loaded. The default is the company physical location.
loadingDateTime	(DateTimeOffset) The goods loading date and time from the loading physical location. The default is the invoice creation date and time.
loadingPointAddress	(string) The physical location address where the goods are loaded. The default is the company physical location address.
loadingWarehouse	(string) The loading warehouse. When defined the warehouse address will replace the loading address values. (fk) Allowed value: the natural key of a record of type Warehouse. These records are accessibly through the Warehouses service.
unloadingPoint	(string) The physical location where the goods are unloaded. Defines the unloading from the freight. The default is customer address.
unloadingStreetName	(string) The street name of the physical location where the goods are unloaded. The default is customer address street name.
unloadingBuildingNumber	(string) The building number of the physical location where the goods are unloaded. The default is customer address building number.
unloadingPostalZone	(string) The postal zone of the physical location where the goods are unloaded. The default is customer address postal zone.
unloadingCityName	(string) The city name of the physical location where the goods are unloaded. The default is customer address city name.
unloadingPointAddress	(string) The physical location address where the goods are unloaded. The default is customer address.
unloadingDateTime	(DateTimeOffset) The goods unloading date and time on the unloading physical location.
vehiclePlateNumber	(string) The vehicle's plate used to trasnport the goods.
hash	(string) Reference value to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
hashControl	(string) Reference value subset to determine the authenticity or integrity of an object. The result of applying a mathematical formula to the object must be equal to this value for it to be authentic. Internally determined.
legalStamp	(string) In some countries, the documents issued by a company have to contain mandatory remarks, clearly visible in printing, which may vary according to the document. These texts are printed under the signature terms. Internally determined.
manualNumber	(int) The invoice's manual serie number. Applicable only when the invoice type series is defined as manual.
manualDate	(DateTime) The invoice's manual date. Applicable only when the invoice type series is defined as manual.
manualSerie	(string) The invoice's manual serie. Applicable only when the invoice type series is defined as manual.
documentLines	(List of InvoiceLineResource) The invoice's lines. See InvoiceLineResource.
documentTaxes	(List of InvoiceTaxResource) The invoice's taxes. See InvoiceTaxResource.
salesChannel	(string) The invoice's sales channel origin. The default value is defined in the sales setup configuration settings. (fk) Allowed value: the natural key of a record of type SalesChannel. These records are accessibly through the SalesChannels service.
dueDate	(DateTime) Date in which the payment is due. In some countries it is also known as law date.
isManualSerie	(bool) Defines if the invoice type series is defined as manual. Internally determined.
fiscalDocumentType	(string) The legal fiscal document type defined on the invoice type. Inferred from the invoice type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
accountingAltAddress	(string) The alternative accounting's party address key to be used on the invoice. The alternative addresses keys are defined on the accounting party addresses. When defined overrides the accounting party address values. (fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
accountingSchema	(enum AccountingSchema) The accounting's organization method. The organization can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
partyAccountingSchema	(enum AccountingSchema) The customer's accounting organization method. The customer organication can follow the rules of "Cash Accounting" or "Accrual Accounting". See AccountingSchema.
notification	(string) The invoice's notification configuration. Inferred from the invoice type. (fk) Allowed value: the natural key of a record of type Notification.
emailTo	(string) The email(s) to send invoice notification. Inferred from the notification.
chartOfAccount	(string) The chart of accounts. Infered from the financial company setup. (fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service.
dimensionSet	(string) The dimension set. Infered from the customer. (fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
journalType	(string) The journal type to be used when posting in accounting. Infered from the invoice type. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
ledger	(string) The ledger to be used when posting in accounting. The default value is the company's General Ledger. (fk) Allowed value: the natural key of a record of type Ledger. These records are accessibly through the Ledgers service.
accountingDocument	(string) The accounting document that was assigned in accounting.
deliveryMode	(string) The delivery mode. (ex: mail). (fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
paymentReference	(string) The payment reference.
dimensionSetJson	(string) Dimension Set Json.
customsDeclaration	(string) The customs declaration.
salesperson	(string) The sales person. The seller of the invoice. (fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
logisticsPartyId	(Guid) The party's unique identifier. It is inferred from the party. Internally setted.
aTQRCode	(string) Unique fiscal document bidimensional QR code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
swift	(string) he society for Worldwide Interbank Financial Telecommunication number.
iBAN	(string) The financial account's International Bank Account Number.
paymentInstruction	(string) The Payment authorization given by the party.
originalTaxExclusiveAmount	(decimal) [Non persisted] The invoice's original total net value. Total value of goods and services after discounts, excluding taxes. Only applicable to external invoices import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
originalTaxAmount	(decimal) [Non persisted] The invoice's original total tax value of goods and services. Only applicable to external invoices import which serie is external and automatic. Rounding differences are automatically applied if the original tax exclusive amount is different than the one calculated internally.
printedReportName	(string) Indicates the report name used to print the document. Internally determined.
isReprinted	(bool) Indicates if the document has been reprinted. Internally determined.
isSigned	(bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.
aTCUD	(string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.

InvoiceReturnOrderLine

The following elements are required:

index

(int) The source document line index.

The following elements are optional:

quantity

(decimal) The source document line quantity to return.

InvoiceTaxResource

The following elements are required:

taxableAmount	(MoneyResource) The amount of revenue subject to tax. This taxable amount is calculated by subtracting the corresponding discounts and allowance charges to the gross value. Internally determined. See MoneyResource .
taxAmount	(MoneyResource) Invoice tax amount. Internally determined. See MoneyResource .
isExempt	(bool) Indicates whether the invoice tax schema is exempt. Internally determined.
roundingTaxableAmount	(MoneyResource) The rounding value of the invoice amount of revenue subject to tax. See MoneyResource .
roundingTaxAmount	(MoneyResource) The rounding value of the invoice tax amount. Internally determined. See MoneyResource .
totalTaxableAmount	(MoneyResource) The total amount of revenue subject to tax. See MoneyResource .
totalTaxAmount	(MoneyResource) The total invoice tax amount. Internally determined. See MoneyResource .
taxTypeCode	(string) Invoice tax type code. Internally determined.
currency	(string) Money unit. Inferred from the invoice currency. Internally determined.

The following elements are optional:

taxPercentage	(decimal) Invoice tax rate percentage. Internally determined.
exemptionReasonCode	(string) Indicates the invoice tax schema exemption reason. Applicable only if the tax schema is exempt. Internally determined.
customExemptionReasonCode	(string) Indicates the invoice tax schema custom exemption reason. Applicable only if the tax schema is exempt. Internally determined.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

StandardInvoiceDocumentLinesResource

The following elements are required:

unit	(string) The invoice's line item sales unit. The default sales unit is defined on the sales item.
unitPrice	(MoneyResource) The invoice's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit. See MoneyResource .
description	(string) The invoice's line item description. The default is defined on the sales item.
itemTaxSchema	(string) The invoice's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
quantity	(decimal) The invoice's line item quantity. The default 1.
salesItem	(string) The sales item representing the good or service to be invoiced.
deliveryDate	(DateTime) The expected line's item delivery date. The default is the document date.
itemType	(enum ItemType) The invoice's line item type. Inferred from the sales item type. Internally determined. See ItemType.

The following elements are optional:

warehouse	(string) The invoice's line item warehouse. The default is defined on the materials item.
discount1	(decimal) The line's item discount 1 percentage. The default is 0.
itemWithholdingTaxSchema	(string) The invoice's line item withholding tax schema. The withholding tax schema identifies the group of withholding taxes a item is liable for. The default withholding tax schema is defined on the sales item.

StandardInvoiceResource

The following elements are required:

documentType	(string) Defines the invoice's purpose. Distinguishes the business transactions to be posted. Part of the document natural key. The default invoice type is defined in the sales setup configuration settings.
company	(string) The company where the invoice is posted. The company code is the central organizational unit within the system.
documentDate	(DateTime) The date when the document is issued.
payableAmount	(MoneyResource) The invoice's payable amount. Total value of goods and services including taxes and discounts. Internally calculated. See MoneyResource .
paymentMethod	(string) The invoice's payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm	(string) The invoice's payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
serie	(string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
seriesNumber	(int) The sequential number internally determined that uniquely identifies the document within the invoice type and serie. Part of the document natural key.
isSimpleInvoice	(bool) Defines if the invoice type is defined as simple invoice type. Internally determined.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
isTransformed	(bool) Defines if the invoice was transformed from the other document. Internally determined.
discount	(decimal) The discount's percentage. The default is defined on the customer party.
isWsCommunicable	(bool) Indicates if the invoice is communicated via web service to fiscal authority. Inferred from the invoice type serie.
cashInvoice	(bool) Indicates whether the invoice is a cash invoice or not. Defined internally and inferred from the invoice type.
isCommunicated	(bool) Flag to know if it is communicated to AT.
buyerCustomerParty	(string) The customer party. Party that the invoice is for.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

documentLines	(List of StandardInvoiceDocumentLinesResource) The invoice's lines. See StandardInvoiceDocumentLinesResource.
fiscalDocumentType	(string) The legal fiscal document type defined on the invoice type. Inferred from the invoice type.
isManualSerie	(bool) Defines if the invoice type series is defined as manual. Internally determined.
note	(string) The document's note.
isPrinted	(bool) Indicates if the invoice has been printed. Internally determined.
dueDate	(DateTime) Date in which the payment is due. In some countries it is also known as law date.
documentStatus	(enum DocumentStatus) The document's status. Internally determined. See DocumentStatus.
printedReportName	(string) Indicates the report name used to print the document. Internally determined.
aTCUD	(string) Unique fiscal document code. The result of applying a mathematical formula to the object that includes the series validation code assigned by the country's tax authority. Internally determined.
isReprinted	(bool) Indicates if the document has been reprinted. Internally determined.
isSigned	(bool) Indicates if the document is electronically signed with a valid certificate. Internally determined.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingSchema

1	Accrual	Acrrual Accounting Schema.
2	Cash

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed
3	Processing

ItemType

1	Item
2	Service