Purchases | Purchases Account
The Purchases Account Determination endpoint is used to discover the purchases account in the company chart of account.
Overview
| URL | api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET PurchasesAcctDeterminations
- GET PurchasesAcctDeterminations (paged)
- GET PurchasesAcctDetermination by identifier
- GET PurchasesAcctDetermination by key
- GET Print PurchasesAcctDetermination by identifier
- GET Print PurchasesAcctDetermination by key
- GET Original Print PurchasesAcctDeterminationOriginal by identifier
- GET Original Print PurchasesAcctDetermination by key
- POST:
-
PUT:
- PUT Set IsActive PurchasesAcctDetermination
- PUT Set PurchasesAcctDeterminationKey PurchasesAcctDetermination
- PUT Set Description PurchasesAcctDetermination
- PUT Set ChartOfAccount PurchasesGLAccount
- PUT Set ItemTaxSchema PurchasesGLAccount
- PUT Set PartyTaxSchema PurchasesGLAccount
- PUT Set PurchaseAccount PurchasesGLAccount
- PUT Set DiscountAccount PurchasesGLAccount
- PUT Set ItemAccountType PurchasesGLAccount
- DELETE:
All Resources
This service uses the following resources:
GET PurchasesAcctDeterminations
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See PurchasesAcctDeterminationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations
GET /purchasesCore/purchasesAcctDeterminations
GET PurchasesAcctDeterminations (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 PurchasesAcctDeterminationResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations?page={page}&pageSize={pageSize}
GET /purchasesCore/purchasesAcctDeterminations?page={page}&pageSize={pageSize}
GET PurchasesAcctDetermination 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 PurchasesAcctDeterminationResource. |
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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{id}
GET /purchasesCore/purchasesAcctDeterminations/{id}
GET PurchasesAcctDetermination by key
Returns the entity record that matches the specified key.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
Response:
| When successful, the response body contains the entity record. See PurchasesAcctDeterminationResource. |
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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}
GET /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}
GET Print PurchasesAcctDetermination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{id}/print?template={template}
GET /purchasesCore/purchasesAcctDeterminations/{id}/print?template={template}
GET Print PurchasesAcctDetermination by key
Prints the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/print
GET /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/print
GET Original Print PurchasesAcctDeterminationOriginal 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{id}/printOriginal?template={template}
GET /purchasesCore/purchasesAcctDeterminations/{id}/printOriginal?template={template}
GET Original Print PurchasesAcctDetermination by key
Prints the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/printOriginal
GET /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/printOriginal
POST PurchasesAcctDeterminations
Creates a new entity record.
The following elements are required:
| purchasesAcctDeterminationResource | (ApiPurchasesAcctDeterminationResource) The request body should contain the entity record that should be created. See ApiPurchasesAcctDeterminationResource. |
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 ApiPurchasesAcctDeterminationResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations
POST /purchasesCore/purchasesAcctDeterminations
POST Purchases Account
Inserts a new 'Account Determination' in the 'Purchases Account'.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| value | (ApiPurchasesAcctDeterminationPurchasesGLAccountsResource) The ApiPurchasesAcctDeterminationPurchasesGLAccountsResource instance. See ApiPurchasesAcctDeterminationPurchasesGLAccountsResource. |
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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts
POST /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts
PUT Set ChartOfAccount PurchasesGLAccount
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/chartOfAccount
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/chartOfAccount
PUT Set Description PurchasesAcctDetermination
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/description
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/description
PUT Set DiscountAccount PurchasesGLAccount
Updates the value of attribute 'DiscountAccount' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/discountAccount
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/discountAccount
PUT Set IsActive PurchasesAcctDetermination
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/isActive
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/isActive
PUT Set ItemAccountType PurchasesGLAccount
Updates the value of attribute 'ItemAccountType' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/itemAccountType
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/itemAccountType
PUT Set ItemTaxSchema PurchasesGLAccount
Updates the value of attribute 'ItemTaxSchema' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/itemTaxSchema
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/itemTaxSchema
PUT Set PartyTaxSchema PurchasesGLAccount
Updates the value of attribute 'PartyTaxSchema' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/partyTaxSchema
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/partyTaxSchema
PUT Set PurchaseAccount PurchasesGLAccount
Updates the value of attribute 'PurchaseAccount' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
| lineId | (string) The detail identifier. |
| 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/purchaseAccount
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}/purchaseAccount
PUT Set PurchasesAcctDeterminationKey PurchasesAcctDetermination
Updates the value of attribute 'PurchasesAcctDeterminationKey' in the specified entity record.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesAcctDeterminationKey
PUT /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesAcctDeterminationKey
DELETE Account Determination by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}
DELETE /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}/purchasesGLAccounts/{lineId}
DELETE PurchasesAcctDetermination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{id}
DELETE /purchasesCore/purchasesAcctDeterminations/{id}
DELETE PurchasesAcctDetermination by key
Deletes the entity record that matches the specified key.
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination 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:
api/{tenantKey}/{orgKey}/purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}
DELETE /purchasesCore/purchasesAcctDeterminations/{purchasesAcctDeterminationKey}
Resources
ApiPurchasesAcctDeterminationPurchasesGLAccountsResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts. |
| purchaseAccount | (string) The purchases account for the item account type, item tax schema and party tax schema selected. |
| itemAccountType | (string) The item account type. |
The following elements are optional:
| itemTaxSchema | (string) The item tax schema. |
| partyTaxSchema | (string) The party tax schema. |
| discountAccount | (string) The discount account for the item account type, item tax schema and party tax schema selected. |
ApiPurchasesAcctDeterminationResource
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
The following elements are optional:
| description | (string) The description of purchases account determination. |
| purchasesGLAccounts | (List of ApiPurchasesAcctDeterminationPurchasesGLAccountsResource) The list of GL accounts.
See ApiPurchasesAcctDeterminationPurchasesGLAccountsResource. |
PurchasesAcctDeterminationResource
The following elements are required:
| purchasesAcctDeterminationKey | (string) The purchases account determination key. |
The following elements are optional:
| description | (string) The description of purchases account determination. |
| purchasesGLAccounts | (List of PurchasesGLAccountResource) The list of GL accounts.
See PurchasesGLAccountResource. |
PurchasesGLAccountResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts. |
| purchaseAccount | (string) The purchases account for the item account type, item tax schema and party tax schema selected. |
| itemAccountType | (string) The item account type. |
The following elements are optional:
| itemTaxSchema | (string) The item tax schema. |
| partyTaxSchema | (string) The party tax schema. |
| discountAccount | (string) The discount account for the item account type, item tax schema and party tax schema selected. |