Financials | Outgoing Check Lot

The Outgoing Check Lot represents the company checks and is used when exits a check payment method like in payments.

Overview

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots

URL	api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST OutgoingCheckLots
PUT:
DELETE:
- DELETE OutgoingCheckLot by identifier
- DELETE OutgoingCheckLot by key

All Resources

This service uses the following resources:

ApiOutgoingCheckLotResource
OutgoingCheckLotResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET OutgoingCheckLots

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots

GET /financialCore/outgoingCheckLots

GET OutgoingCheckLots (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 OutgoingCheckLotResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots?page={page}&pageSize={pageSize}

GET /financialCore/outgoingCheckLots?page={page}&pageSize={pageSize}

GET OutgoingCheckLot 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 OutgoingCheckLotResource.

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}/financialCore/outgoingCheckLots/{id}

GET /financialCore/outgoingCheckLots/{id}

GET OutgoingCheckLot by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
outgoingCheckLotKey	(string) The check lot key.

Response:

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

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}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}

GET /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}

GET Print OutgoingCheckLot 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}/financialCore/outgoingCheckLots/{id}/print?template={template}

GET /financialCore/outgoingCheckLots/{id}/print?template={template}

GET Print OutgoingCheckLot by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
outgoingCheckLotKey	(string) The check lot 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}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/print

GET /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/print

GET Original Print OutgoingCheckLotOriginal 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}/financialCore/outgoingCheckLots/{id}/printOriginal?template={template}

GET /financialCore/outgoingCheckLots/{id}/printOriginal?template={template}

GET Original Print OutgoingCheckLot by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
outgoingCheckLotKey	(string) The check lot 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}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/printOriginal

GET /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/printOriginal

POST Operations

POST OutgoingCheckLots

Creates a new entity record.

The following elements are required:

outgoingCheckLotResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots

POST /financialCore/outgoingCheckLots

PUT Operations

PUT Set Company OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/company

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/company

PUT Set Description OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/description

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/description

PUT Set FinalNumber OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot key.
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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/finalNumber

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/finalNumber

PUT Set FinancialAccount OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/financialAccount

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/financialAccount

PUT Set InicialNumber OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot key.
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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/inicialNumber

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/inicialNumber

PUT Set IsActive OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/isActive

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/isActive

PUT Set OutgoingCheckLotKey OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/outgoingCheckLotKey

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/outgoingCheckLotKey

PUT Set PlaceOfIssue OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/placeOfIssue

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/placeOfIssue

PUT Set Validity OutgoingCheckLot

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

The following elements are required:

outgoingCheckLotKey	(string) The check lot key.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/validity

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/validity

PUT Set Custom Attribute OutgoingCheckLot

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

The following elements are required:

companyKey	(string) The company key.
outgoingCheckLotKey	(string) The check lot 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:

api/{tenantKey}/{orgKey}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/{customAttributeName}

PUT /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}/{customAttributeName}

DELETE Operations

DELETE OutgoingCheckLot 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}/financialCore/outgoingCheckLots/{id}

DELETE /financialCore/outgoingCheckLots/{id}

DELETE OutgoingCheckLot by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
outgoingCheckLotKey	(string) The check lot 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}/financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}

DELETE /financialCore/outgoingCheckLots/{companyKey}/{outgoingCheckLotKey}

Resources

ApiOutgoingCheckLotResource

The following elements are required:

outgoingCheckLotKey	(string) The check lot key.
inicialNumber	(int) The first check number of the lot.
finalNumber	(int) The last check number of the lot.
validity	(DateTime) The validity of the check lot.
financialAccount	(string) The bank account from the check lot.
company	(string) The company key that owns the check lot.

The following elements are optional:

placeOfIssue	(string) The default place of issue of the checks.
description	(string) Enter a description of the check lot.

OutgoingCheckLotResource

The following elements are required:

outgoingCheckLotKey	(string) The check lot key.
inicialNumber	(int) The first check number of the lot.
finalNumber	(int) The last check number of the lot.
validity	(DateTime) The validity of the check lot.
financialAccount	(string) The bank account from the check lot. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
company	(string) The company key that owns the check lot. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

placeOfIssue	(string) The default place of issue of the checks.
description	(string) Enter a description of the check lot.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.