Transfer Group Template

The Transfer Group Template API allows the user to create and use a transfer group template.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /transfer-group-template/schema

Summary

Get the transfer group template schema.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document

Responses

Code	Description	Schema
200	Success	transfer_group_template_get_response_1
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

POST /transfer-group-template

Summary

Create the transfer group template.

Request Parameters

In	Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	transfer_group_template_post_body	Yes	The JSON formatted request

Responses

Code	Description	Schema
201	Success	transfer_group_template_post_response
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

GET /transfer-group-template

Summary

Get the transfer group template list.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$top`	integer	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	integer	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$select`	string	No
query	`$orderby`	string	No	An order by expression in OData v4 format

Responses

Code	Description	Schema
200	Success	transfer_group_template_get_response_2
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

PATCH /transfer-group-template/{id}

Summary

Update the transfer group template.

Request Parameters

In	Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	The transfer group's document ID from the database
body	`body`	transfer_group_template_patch_body	Yes	The JSON formatted request

Responses

Code	Description	Schema
204	No content
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

DELETE /transfer-group-template/{id}

Summary

Delete the transfer group template by its identifier (ID).

Request Parameters

In	Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	The transfer group's document ID from the database

Responses

Code	Description	Schema
204	No content
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

GET /transfer-group-template/{id}

Summary

Get the transfer group template details.

Request Parameters

In	Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	The transfer group's document ID from the database

Responses

Code	Description	Schema
200	Success	transfer_group_template_get_response_3
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Data Models