Purchases | Invoice Type

The Invoice Type represents a purchases invoice with specific characteristics.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET InvoiceTypes
  • GET InvoiceTypes (paged)
  • GET InvoiceType by identifier
  • GET InvoiceType by key
  • GET Print InvoiceType by identifier
  • GET Print InvoiceType by key
  • GET Original Print InvoiceTypeOriginal by identifier
  • GET Original Print InvoiceType by key
• POST:
  • POST InvoiceTypes
  • POST Invoice Type
• PUT:
  • PUT Set Custom Attribute InvoiceType
  • PUT Set Custom Attribute InvoiceTypeSerie
  • PUT Set IsActive InvoiceType
  • PUT Set Company InvoiceType
  • PUT Set TypeKey InvoiceType
  • PUT Set Description InvoiceType
  • PUT Set CashInvoice InvoiceType
  • PUT Set DefaultCashFlowItem InvoiceType
  • PUT Set DefaultCreditMemoType InvoiceType
  • PUT Set DefaultDebitMemoType InvoiceType
  • PUT Set AccountingSchema InvoiceType
  • PUT Set ContactType InvoiceType
  • PUT Set Notification InvoiceType
  • PUT Set SupplierPostingProfile InvoiceType
  • PUT Set DimensionCombination InvoiceType
  • PUT Set PurchasesAcctDetermination InvoiceType
  • PUT Set JournalType InvoiceType
  • PUT Set DefaultFinancialAccount InvoiceType
  • PUT Set CompanyHasDimensions InvoiceType
  • PUT Set IsDefault InvoiceTypeSerie
  • PUT Set NumberOfCopies InvoiceTypeSerie
  • PUT Set TaxIncluded 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
• InvoiceTypeSerieResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AccountingSchema

GET Operations

GET InvoiceTypes

Returns the list of all the entity records available.

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 InvoiceTypes (paged)

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

The following elements are optional:

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

Response:

When successful, the response body contains the list of records available. See 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 key for the invoice type.

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 Print InvoiceType by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

GET Print InvoiceType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the invoice type.

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 InvoiceTypeOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

GET Original Print InvoiceType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the invoice type.

The following elements are optional:

template

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

Response:

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

Response status codes:

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

Resource URL:

POST Operations

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

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

Response status codes:

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

Resource URL:

POST Invoice Type

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

The following elements are required:

typeKey	(string) The key for the invoice type.
companyKey	(string) The company key.
value	(ApiInvoiceTypeDocumentTypeSeriesResource) The ApiInvoiceTypeDocumentTypeSeriesResource instance. See ApiInvoiceTypeDocumentTypeSeriesResource.

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.

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 key for the invoice type.
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 CashInvoice InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 Company InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 CompanyHasDimensions InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 ContactType InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 DimensionCombination InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 JournalType InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 PurchasesAcctDetermination InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 SupplierPostingProfile InvoiceType

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

The following elements are required:

typeKey	(string) The key for the invoice type.
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 key for the invoice type.
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 key for the invoice type.
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 InvoiceType

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

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the invoice type.
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 InvoiceTypeSerie

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

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the invoice type.
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 Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The key for the invoice type.
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 key for the invoice type.

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:

isDefault	(bool) Indicates if this is the default serie for the document.
numberOfCopies	(int) The number of copies of the document to print.
serie	(string) The range of identification values that group a set of product entities or objects.

The following elements are optional:

taxIncluded

(bool) When checked, the document unit prices will include taxes.

ApiInvoiceTypeResource

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
typeKey	(string) The key for the invoice type.
cashInvoice	(bool) It is an invoice which also documents an on-time payment receipt in cash, unlike an invoice or a promise of payment.
supplierPostingProfile	(string) The supplier posting profile used for supplier account determination.
purchasesAcctDetermination	(string) The purchases GL account determinations for line item.
journalType	(string) The journal type to be used for account posting.
companyHasDimensions	(bool) Flag to know if company has dimensions.

The following elements are optional:

description	(string) The description for the invoice type.
documentTypeSeries	(List of ApiInvoiceTypeDocumentTypeSeriesResource) The list of available series for this document type. See ApiInvoiceTypeDocumentTypeSeriesResource.
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.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
contactType	(string) The contact type for the invoice type.
notification	(string) The default notification for documents with this invoice type.
dimensionCombination	(string) The dimension combination used for line item dimension determination.
defaultFinancialAccount	(string) The default financial account to be used for invoice/receipt.

InvoiceTypeResource

The following elements are required:

company	(string) 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.
typeKey	(string) The key for the invoice type.
cashInvoice	(bool) It is an invoice which also documents an on-time payment receipt in cash, unlike an invoice or a promise of payment.
supplierPostingProfile	(string) The supplier posting profile used for supplier account determination. (fk) Allowed value: the natural key of a record of type SupplierPostingProfile. These records are accessibly through the SupplierPostingProfiles service.
purchasesAcctDetermination	(string) The purchases GL account determinations for line item. (fk) Allowed value: the natural key of a record of type PurchasesAcctDetermination. These records are accessibly through the PurchasesAcctDeterminations service.
journalType	(string) The journal type to be used for account posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
companyHasDimensions	(bool) Flag to know if company has dimensions.

The following elements are optional:

description	(string) The description for the invoice type.
documentTypeSeries	(List of InvoiceTypeSerieResource) The list of available series for this document type. See InvoiceTypeSerieResource.
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.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
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.
dimensionCombination	(string) The dimension combination used for line item dimension determination. (fk) Allowed value: the natural key of a record of type DimensionCombination. These records are accessibly through the DimensionCombinations service.
defaultFinancialAccount	(string) The default financial account to be used for invoice/receipt. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.

InvoiceTypeSerieResource

The following elements are required:

isDefault	(bool) Indicates if this is the default serie for the document.
numberOfCopies	(int) The number of copies of the document to print.
serie	(string) The range of identification values that group a set of product entities or objects.

The following elements are optional:

currentNumber	(int) The current document's number.
currentDate	(DateTime) The current date for the invoice type serie.
taxIncluded	(bool) When checked, the document unit prices will include taxes.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingSchema

1	Accrual	Acrrual Accounting Schema.
2	Cash