Create a checkbook for a bank account
post
/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}/child/bankAccountCheckbooks
Request
Path Parameters
-
BankAccountId(required): integer(int64)
The unique identifier of the bank account.
-
PaymentDocumentId(required): integer(int64)
The unique identifier of the bank account payment document.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CheckbookId: integer
(int64)
The unique identifier of the bank account checkbook.
-
CheckbookName: string
Title:
Checkbook
Maximum Length:240
The name of the checkbook. -
DateReceived: string
(date)
Title:
Received Date
The date when the checkbook was received. -
EndNumber: number
Title:
End Number
The ending number of the checkbook. -
Prefix: string
Title:
Prefix
Maximum Length:30
The prefix used for the checkbook. -
StartNumber: number
Title:
Start Number
The starting number of the checkbook.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-response
Type:
Show Source
object
-
CheckbookId: integer
(int64)
The unique identifier of the bank account checkbook.
-
CheckbookName: string
Title:
Checkbook
Maximum Length:240
The name of the checkbook. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
DateReceived: string
(date)
Title:
Received Date
The date when the checkbook was received. -
EndNumber: number
Title:
End Number
The ending number of the checkbook. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoOfDocuments: string
Title:
Number of Documents
Read Only:true
The number of documents associated to the checkbook. -
Prefix: string
Title:
Prefix
Maximum Length:30
The prefix used for the checkbook. -
StartNumber: number
Title:
Start Number
The starting number of the checkbook.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.