Sales | Invoice

Service to manage entities of type 'Invoice'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Invoices (odata)
  • GET Invoice by identifier
  • GET Invoice by key
  • GET Print Invoice by identifier
  • GET Print Invoice by identifier (asynchronously)
  • GET Print Invoice by key
  • GET Print Invoice by key (asynchronously)
  • GET Original Print Invoice by identifier
  • GET Original Print Invoice by identifier (asynchronously)
  • GET Original Print Invoice by key
  • GET Original Print Invoice by key (asynchronously)
• POST:
  • POST Invoices
  • POST Communicate To Tax Authority
  • POST From Quotation
  • POST Generate Cius
• PUT:
  • PUT Set Custom Attribute Invoice
  • PUT Set Custom Attribute InvoiceLine
  • PUT Set IsActive Invoice
  • PUT Set FinancialAccount Invoice
  • PUT Set Remarks Invoice
  • PUT Set Note Invoice
  • PUT Set NoteToRecipient Invoice
  • PUT Set AccountingSchema Invoice
  • PUT Set EmailTo Invoice
  • PUT Set DefaultItemWithholdingId Invoice
  • PUT Set PrintedReportName Invoice
  • PUT Set ExternalSourceDoc Invoice
  • PUT Set IsSeriesCommunicated Invoice
  • PUT Set RecurringInvoiceSchedule Invoice
  • PUT Set CustomerOrderId Invoice
  • PUT Set CommitmentReference Invoice
  • PUT Set CommitmentReference InvoiceLine
  • PUT Set CustomerOrderId InvoiceLine
  • PUT Set CustomerOrderLine InvoiceLine
  • PUT Set ExternalSourceDoc InvoiceLine
• DELETE:
  • DELETE Invoice by identifier
  • DELETE Invoice by key

All Resources

This service uses the following resources:

• ApiInvoiceDocumentLinesResource
• ApiInvoiceDocumentTaxesResource
• ApiInvoicePaymentMethodsResource
• ApiInvoiceResource
• InvoiceResource
• MoneyResource
• StandardInvoiceDocumentLinesResource
• StandardInvoiceResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AccountingSchema
• DocumentLineStatus
• DocumentStatus
• ItemType

GET Operations

GET Invoices (odata)

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

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

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 record does not exist.

Resource URL:

GET Print Invoice by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

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 Print Invoice by key (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Original 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 record does not exist.

Resource URL:

GET Original Print Invoice by identifier (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

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:

GET Original Print Invoice by key (asynchronously)

Prints the specified entity record asynchronously.

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 Location header contains an URL to download the printed file.

Response status codes:

202	Accepted. The operation was accepted. The response Location header contains the address to obtain the printed file when it's ready.
400	BadRequest. The request parameters are invalid.

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 Communicate To Tax Authority

Custom operation 'CommunicateToTaxAuthority'.

The following elements are required:

invoiceId

(Guid) InvoiceId.

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 string.

Resource URL:

POST From Quotation

Custom operation 'FromQuotation'.

The following elements are required:

quotationId

(Guid) QuotationId.

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 CommitmentReference Invoice

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.
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 CustomerOrderId Invoice

Updates the value of attribute 'CustomerOrderId' 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 CustomerOrderId InvoiceLine

Updates the value of attribute 'CustomerOrderId' 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 CustomerOrderLine InvoiceLine

Updates the value of attribute 'CustomerOrderLine' 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 DefaultItemWithholdingId Invoice

Updates the value of attribute 'DefaultItemWithholdingId' 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 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 ExternalSourceDoc Invoice

Updates the value of attribute 'ExternalSourceDoc' 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 ExternalSourceDoc InvoiceLine

Updates the value of attribute 'ExternalSourceDoc' 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 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 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 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 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 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 RecurringInvoiceSchedule Invoice

Updates the value of attribute 'RecurringInvoiceSchedule' 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 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

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.
deliveryDate	(DateTime) The expected line's item delivery date. The default is the document date.

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.
transactionAccount	(string) The invoice's line item transaction account. Inferred from the sales item income account. Internally determined.
commitmentReference	(string) Commitment Ref.
customerOrderId	(string) Customer Order.
customerOrderLine	(string) Line.
externalSourceDoc	(string) Identifier of an external source document. It can only be indicated if there is no other source document present in the system.

ApiInvoiceDocumentTaxesResource

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.

ApiInvoicePaymentMethodsResource

The following elements are required:

paymentMethod	(string) The payment method.
amount	(MoneyResource) The amount paid via the indicated payment method. See MoneyResource .
isMain	(bool) Indicates the main payment method. When a payment method is marked as 'main', it will overwrite the payment method in the document header and the paid amount of it will be calculated automatically.

The following elements are optional:

financialAccount

(string) The financial account.

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 memo's company. 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.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
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.
discountInValueAmount	(MoneyResource) Discount In Value. 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.
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) A financial account that represents either a cash drawer or a bank account and must be used to define where to credit the value. A bank account is 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.
checkDate	(DateTime) The payment's check date. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkBank	(string) The payment's check bank. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkBranch	(string) The payment's check bank branch. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkAccount	(string) The payment's check bank account. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkEndorsed	(bool) Defines if the payment check endsorded. Applicable only when the invoice is cash invoice and the payment method is of type check. In some countries, the beneficiary can endorse the check, which allows him or her to specify a third party to whom it should be paid.
checkNumber	(string) The payment's check number. Applicable only when the invoice is cash invoice and the payment method is of type check.
issuePlace	(string) The payment's check issue place. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkPayment	(bool) Determines if the used payment method is of type check. Applicable only when the invoice is cash invoice and the payment method is of type check. Internally determined.
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.
salesperson	(string) The sales person associated to the invoice. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party.
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.
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 or the document's type series settings.
dueDate	(DateTime) Date in which the payment is due. In some countries it is also known as law date.
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.
defaultItemWithholding	(string) For subscriptions with SimplifiedWithholdingManagement Claim, the Item Withholding is selected on master and applied to all details.
defaultItemWithholdingId	(Guid) For subscriptions with SimplifiedWithholdingManagement Claim, the Item Withholding is selected on master and applied to all details.
store	(string) The invoice's store origin. The default value is defined in the document's type series settings.
deviceToken	(string) The device token. Required for integrations with devices, is used on device validations at document creation (otherwise it shoud not be set).
paymentMethods	(List of ApiInvoicePaymentMethodsResource) The invoice's payment methods. For cash invoice documents, it is possible to define more than one payment method. The payment method identified as 'main' (or the first one if there is no one identified as 'main') will override the payment method in the document header. See ApiInvoicePaymentMethodsResource.
printedReportName	(string) Printed Report Name.
externalSourceDoc	(string) Default value for setup an external source document on invoice's lines.
recurringInvoiceSchedule	(string) Recurring Invoice Schedule.
customerOrderId	(string) Customer Order.
commitmentReference	(string) Commitment Reference.

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 memo's company. 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.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services). (fk) Allowed value: the natural key of a record of type CustomerParty. These records are accessibly through the CustomerParties service.
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.
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.
isCommunicated	(bool) Is Communicated.
discountInValueAmount	(MoneyResource) Discount In Value. See MoneyResource .
isLocked	(bool) Is Locked.
isSeriesCommunicated	(bool) Is Series Communicated.
ignoreAssociatedSalesItems	(bool) Ignore Associated Sales Items.

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) A financial account that represents either a cash drawer or a bank account and must be used to define where to credit the value. A bank account is 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.
checkDate	(DateTime) The payment's check date. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkBank	(string) The payment's check bank. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkBranch	(string) The payment's check bank branch. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkAccount	(string) The payment's check bank account. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkEndorsed	(bool) Defines if the payment check endsorded. Applicable only when the invoice is cash invoice and the payment method is of type check. In some countries, the beneficiary can endorse the check, which allows him or her to specify a third party to whom it should be paid.
checkNumber	(string) The payment's check number. Applicable only when the invoice is cash invoice and the payment method is of type check.
issuePlace	(string) The payment's check issue place. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkPayment	(bool) Determines if the used payment method is of type check. Applicable only when the invoice is cash invoice and the payment method is of type check. Internally determined.
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.
salesperson	(string) The sales person associated to the invoice. Sales representative or salesman (whether he is under direct control of a company or not) is authorized to procure business opportunities for a company. The default is defined on the customer party. (fk) Allowed value: the natural key of a record of type Salesperson. These records are accessibly through the Salespersons service.
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 or the document's type series 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.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. 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. These records are accessibly through the Notifications service.
emailTo	(string) The email(s) to send invoice notification. Inferred from the notification.
isCheckPayment	(bool) Is Check Payment.
defaultItemWithholding	(string) For subscriptions with SimplifiedWithholdingManagement Claim, the Item Withholding is selected on master and applied to all details.
partyWithholdingMessage	(string) For subscriptions with SimplifiedWithholdingManagement Claim, when the Party has no associated Withholding regime, a message is shown.
partyHasWithholding	(bool) Party Has Withholding.
defaultItemWithholdingId	(Guid) For subscriptions with SimplifiedWithholdingManagement Claim, the Item Withholding is selected on master and applied to all details.
printAllDiscounts	(string) Discount.
lockReason	(string) Lock Reason. (fk) Allowed value: the natural key of a record of type EntityLockReason. These records are accessibly through the EntityLockReasons service.
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.
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.
store	(string) The invoice's store origin. The default value is defined in the document's type series settings. (fk) Allowed value: the natural key of a record of type Store. These records are accessibly through the Stores service.
deviceToken	(string) The device token. Required for integrations with devices, is used on device validations at document creation (otherwise it shoud not be set).
isExclusiveForPOSDevice	(bool) Defines if the invoice type series is defined as ExclusiveForPOSDevice. Internally determined.
paymentMethods	(List of InvoicePaymentMethodLineResource) The invoice's payment methods. For cash invoice documents, it is possible to define more than one payment method. The payment method identified as 'main' (or the first one if there is no one identified as 'main') will override the payment method in the document header. See InvoicePaymentMethodLineResource.
printAllPaymentMethods	(string) Payment Methods.
printedReportName	(string) Printed Report Name.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
externalSourceDoc	(string) Default value for setup an external source document on invoice's lines.
recurringInvoiceSchedule	(string) Recurring Invoice Schedule. (fk) Allowed value: the natural key of a record of type RecurringInvoiceSchedule. These records are accessibly through the RecurringInvoiceSchedules service.
customerOrderId	(string) Customer Order.
commitmentReference	(string) Commitment Reference.

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.
deliveryLine	(int) The source delivery's line index when the invoice is transformed from a transport document.
commitmentReference	(string) Commitment Ref.

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 memo's company. The company code is the central organizational unit within the system.
buyerCustomerParty	(string) The customer party that receives or consumes products (goods or services).
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.
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.
taxTotal	(MoneyResource) The total’s 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 .
wTaxTotal	(MoneyResource) The total’s withholding tax value of 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 .
allowanceChargeAmount	(MoneyResource) The total’s discount over goods and services. Internally calculated. See MoneyResource .
grossValue	(MoneyResource) The total’s value of goods and services before taxes or discounts. Internally calculated. See MoneyResource .
isCommunicated	(bool) Is Communicated.
discountInValueAmount	(MoneyResource) Discount In Value. See MoneyResource .
isLocked	(bool) Is Locked.
isSeriesCommunicated	(bool) Is Series Communicated.

The following elements are optional:

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.
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.
isOneTimeCustomer	(bool) Defines if the customer party is a marked as an one time customer. Internally determined.
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.
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.
checkDate	(DateTime) The payment's check date. Applicable only when the invoice is cash invoice and the payment method is of type check.
checkNumber	(string) The payment's check number. Applicable only when the invoice is cash invoice and the payment method is of type check.
dueDate	(DateTime) Date in which the payment is due. In some countries it is also known as law date.
financialAccount	(string) A financial account that represents either a cash drawer or a bank account and must be used to define where to credit the value. A bank account is 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.
checkPayment	(bool) Determines if the used payment method is of type check. Applicable only when the invoice is cash invoice and the payment method is of type check. Internally determined.
accountingPartyAddress	(string) The accounting's customer address. It is inferred from the accounting 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.
defaultItemWithholding	(string) For subscriptions with SimplifiedWithholdingManagement Claim, the Item Withholding is selected on master and applied to all details.
partyWithholdingMessage	(string) For subscriptions with SimplifiedWithholdingManagement Claim, when the Party has no associated Withholding regime, a message is shown.
partyHasWithholding	(bool) Party Has Withholding.
noteToRecipient	(string) The note to the invoice recipient.
isCheckPayment	(bool) Is Check Payment.
defaultItemWithholdingId	(Guid) For subscriptions with SimplifiedWithholdingManagement Claim, the Item Withholding is selected on master and applied to all details.
documentStatus	(enum DocumentStatus) The document's status. Internally determined. See DocumentStatus.
lockReason	(string) Lock Reason.
isExclusiveForPOSDevice	(bool) Defines if the invoice type series is defined as ExclusiveForPOSDevice. Internally determined.
isReprinted	(bool) Is Reprinted.
isSigned	(bool) Is Signed.
printedReportName	(string) Printed Report Name.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed

ItemType

1	Item
2	Service
3	SpecialSalesTaxes
4	Tax
5	Other