Sales | Invoice Type

Service to manage entities of type 'InvoiceType'.

Overview

URL	api/{tenantKey}/{orgKey}/salesCore/invoiceTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET InvoiceTypes (odata)
  • GET InvoiceType by identifier
  • GET InvoiceType by key
• POST:
  • POST InvoiceTypes
  • POST Invoice Type Serie
• PUT:
  • PUT Set IsActive InvoiceType
  • PUT Set Company InvoiceType
  • PUT Set TypeKey InvoiceType
  • PUT Set Description InvoiceType
  • PUT Set FiscalDocumentType InvoiceType
  • PUT Set CashInvoice InvoiceType
  • PUT Set AccountingSchema InvoiceType
  • PUT Set DefaultCashFlowItem InvoiceType
  • PUT Set DefaultCreditMemoType InvoiceType
  • PUT Set DefaultDebitMemoType InvoiceType
  • PUT Set ContactType InvoiceType
  • PUT Set Notification InvoiceType
  • PUT Set DefaultFinancialAccount InvoiceType
  • PUT Set DefaultMemoReason InvoiceType
  • PUT Set DocumentNoteTitle InvoiceType
  • PUT Set DocumentNote InvoiceType
  • PUT Set NumberOfCopies InvoiceTypeSerie
  • PUT Set IsDefault InvoiceTypeSerie
  • PUT Set TaxIncluded InvoiceTypeSerie
  • PUT Set IsManual InvoiceTypeSerie
  • PUT Set IsExternal InvoiceTypeSerie
  • PUT Set EconomicActivityClass InvoiceTypeSerie
  • PUT Set CommunicationType InvoiceTypeSerie
  • PUT Set SalesChannel InvoiceTypeSerie
  • PUT Set ATValidationCode InvoiceTypeSerie
  • PUT Set ATManualCommunication InvoiceTypeSerie
  • PUT Set Led InvoiceTypeSerie
  • PUT Set Store InvoiceTypeSerie
  • PUT Set ExclusiveForPOSDevice InvoiceTypeSerie
• DELETE:
  • DELETE Invoice Type Serie by identifier
  • DELETE InvoiceType by identifier
  • DELETE InvoiceType by key

All Resources

This service uses the following resources:

• ApiInvoiceTypeDocumentTypeSeriesResource
• ApiInvoiceTypeResource
• InvoiceTypeResource

All Enumerations

This service uses the following enumerations:

• AccountingSchema
• CommunicationType

GET Operations

GET InvoiceTypes (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 InvoiceTypeResource.

Response status codes:

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

Resource URL:

GET InvoiceType 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 InvoiceTypeResource.

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 InvoiceType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The invoice's type key.

Response:

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

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 InvoiceTypes

Creates a new entity record.

The following elements are required:

invoiceTypeResource

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

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

Response status codes:

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

Resource URL:

POST Invoice Type Serie

Inserts a new 'Invoice Type Serie' in the 'Invoice Type'.

The following elements are required:

typeKey	(string) The invoice's type key.
companyKey	(string) The company key.
value	(ApiInvoiceTypeDocumentTypeSeriesResource) The ApiInvoiceTypeDocumentTypeSeriesResource instance. See ApiInvoiceTypeDocumentTypeSeriesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set AccountingSchema InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 ATManualCommunication InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
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 ATValidationCode InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type 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 CashInvoice InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 CommunicationType InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum CommunicationType) The request body should contain the new value for the attribute. See CommunicationType.

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 Company InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 ContactType InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DefaultCashFlowItem InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DefaultCreditMemoType InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DefaultDebitMemoType InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DefaultFinancialAccount InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DefaultMemoReason InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 Description InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DocumentNote InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 DocumentNoteTitle InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 EconomicActivityClass InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type 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 ExclusiveForPOSDevice InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
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 FiscalDocumentType InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 IsDefault InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
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 IsExternal InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
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 IsManual InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
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 Led InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type 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 Notification InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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 NumberOfCopies InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type 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 SalesChannel InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type 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 Store InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type 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 TaxIncluded InvoiceTypeSerie

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

The following elements are required:

typeKey	(string) The invoice's type key.
lineId	(string) The detail identifier.
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 TypeKey InvoiceType

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

The following elements are required:

typeKey	(string) The invoice's type 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:

DELETE Operations

DELETE Invoice Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The invoice's type key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE InvoiceType 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 InvoiceType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The invoice's type 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

ApiInvoiceTypeDocumentTypeSeriesResource

The following elements are required:

numberOfCopies	(int) The number of copies of the document to print.
isDefault	(bool) Indicates if this is the default serie for the document.
taxIncluded	(bool) When checked, the document unit prices will include taxes.
isManual	(bool) Defines if the invoice type series is defined as manual. Internally determined.
isExternal	(bool) Defines if the invoice type series is defined as external. Internally determined.
serie	(string) The range of identification values that group a set of product entities or objects.
communicationType	(enum CommunicationType) The type of comunication to be used. This is applicable only to Portuguese companies. See CommunicationType.
aTManualCommunication	(bool) Manual Communication.
exclusiveForPOSDevice	(bool) Indicates if this series is used exclusively in POS devices.

The following elements are optional:

economicActivityClass	(string) Indicates the company's activity.
salesChannel	(string) Indicates the sales channel used by default for this document type series.
aTValidationCode	(string) Validation Code.
led	(string) Place of issue of the document. It is required for electronic communication of the document in Cape Verde.
store	(string) Indicates the store used by default for this document type series. Must belong to the indicated sales channel.

ApiInvoiceTypeResource

The following elements are required:

company	(string) The invoice's type company. The company's code is the central organizational unit within the system.
typeKey	(string) The invoice's type key.
cashInvoice	(bool) It is an invoice which also documents an on-time payment receipt in cash, unlike an invoice or a promise of payment.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.

The following elements are optional:

description	(string) The invoice's type description.
documentTypeSeries	(List of ApiInvoiceTypeDocumentTypeSeriesResource) The invoice's type details. See ApiInvoiceTypeDocumentTypeSeriesResource.
fiscalDocumentType	(string) The fiscal's document type.
defaultCashFlowItem	(string) The type of cash flow item to be used when CashInvoice is active.
defaultCreditMemoType	(string) The type of credit memo type for the invoice type.
defaultDebitMemoType	(string) The type of debit memo type for the invoice type.
contactType	(string) The contact type for the invoice type.
notification	(string) The default notification for documents with this invoice type.
defaultFinancialAccount	(string) The default financial account to be used in invoice/receipts.
defaultMemoReason	(string) The default Memo Reason to be used in memos.
documentNoteTitle	(string) The title of the document note will be printed in bold above the document note.
documentNote	(string) This note will be printed in the standard invoice layout.

InvoiceTypeResource

The following elements are required:

company	(string) The invoice's type company. The company's 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.
typeKey	(string) The invoice's type key.
cashInvoice	(bool) It is an invoice which also documents an on-time payment receipt in cash, unlike an invoice or a promise of payment.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
isPortugueseCompany	(bool) Indicates if the invoice type is targeted at a company that is portuguese.

The following elements are optional:

description	(string) The invoice's type description.
documentTypeSeries	(List of InvoiceTypeSerieResource) The invoice's type details. See InvoiceTypeSerieResource.
fiscalDocumentType	(string) The fiscal's document type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
defaultCashFlowItem	(string) The type of cash flow item to be used when CashInvoice is active. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
defaultCreditMemoType	(string) The type of credit memo type for the invoice type. (fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service.
defaultDebitMemoType	(string) The type of debit memo type for the invoice type. (fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service.
contactType	(string) The contact type for the invoice type. (fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service.
notification	(string) The default notification for documents with this invoice type. (fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service.
defaultFinancialAccount	(string) The default financial account to be used in invoice/receipts. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
defaultMemoReason	(string) The default Memo Reason to be used in memos. (fk) Allowed value: the natural key of a record of type MemoReason. These records are accessibly through the MemoReasons service.
documentNoteTitle	(string) The title of the document note will be printed in bold above the document note.
documentNote	(string) This note will be printed in the standard invoice layout.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

CommunicationType

1	WebService
2	SAFT
3	NoCommunication
4	Manual