Account
GET /api/accounts/account
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/account
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/account
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/account[/:account_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/account[/:account_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/account[/:account_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/account[/:account_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| name | NO | ||
| owner | NO | ||
| contractor | YES | ||
| customer | YES | ||
| rate | YES | ||
| creditLimit | YES | ||
| rateEffective | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
BillingAdapter
GET /api/accounts/billing-adapter
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/billing-adapter
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/billing-adapter
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/billing-adapter[/:billing_adapter_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/billing-adapter[/:billing_adapter_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/billing-adapter[/:billing_adapter_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/billing-adapter[/:billing_adapter_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | |
| Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
EntityTransitionsService
GET /api/accounts/entity-transitions
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/entity-transitions
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/entity-transitions
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/entity-transitions[/:entity_transition_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/entity-transitions[/:entity_transition_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/entity-transitions[/:entity_transition_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/accounts/entity-transitions[/:entity_transition_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
BackendTasksService
GET /api/accounts/events/backend-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/events/backend-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/events/backend-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/events/backend-tasks[/:backend_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/events/backend-tasks[/:backend_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/events/backend-tasks[/:backend_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/accounts/events/backend-tasks[/:backend_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| request | NO | ||
| result | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
JobTasksService
GET /api/accounts/events/job-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/events/job-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/events/job-tasks
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/accounts/events/job-tasks[/:job_task_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| name | NO | ||
| timetable | NO | ||
| extId | NO | ||
| owner | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
JobsService
GET /api/accounts/events/jobs
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/events/jobs
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/events/jobs
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/accounts/events/jobs[/:job_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| data | NO | ||
| result | NO | ||
| jobTask | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Invoice
GET /api/accounts/invoice
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/invoice
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/invoice
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/invoice
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/invoice[/:invoice_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/invoice[/:invoice_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/invoice[/:invoice_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/invoice[/:invoice_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| payer | YES | ||
| payee | YES | ||
| value | YES | ||
| comment | NO | ||
| paymentTerm | NO | ||
| paymentDate | NO | ||
| transactions | NO | ||
| tax | NO | ||
| paymentOrderNumber | NO | ||
| paymentOrderDate | NO | ||
| conditionalPaymentDocument | NO | ||
| conditionalPaymentTerm | NO | ||
| moderatorComment | NO | ||
| extId | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/*+document |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
LegalEntity
GET /api/accounts/legal-entity
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/legal-entity
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/legal-entity
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/legal-entity[/:legal_entity_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/legal-entity[/:legal_entity_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/legal-entity[/:legal_entity_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/legal-entity[/:legal_entity_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| type | YES | ||
| tax | NO | ||
| name | YES | ||
| owner | NO | ||
| contractNumber | NO | ||
| eav | array | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Payment
GET /api/accounts/payment
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/payment
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/payment
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/payment[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/payment[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/payment[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/payment[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/accounts/payment[/:payment_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| owner | YES | ||
| transactionDate | NO | ||
| value | YES | ||
| comment | NO | ||
| account | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
AccountsService
GET /api/accounts/rate-effective
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/rate-effective
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/rate-effective
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/rate-effective[/:rate_effective_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/rate-effective[/:rate_effective_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/rate-effective[/:rate_effective_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/json
application/vnd.orderadmin\accounts\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/accounts/rate-effective[/:rate_effective_id]
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
RateModifier
GET /api/accounts/rate-modifier
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/rate-modifier
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/rate-modifier
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/rate-modifier[/:rate_modifier_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/rate-modifier[/:rate_modifier_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/rate-modifier[/:rate_modifier_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/rate-modifier[/:rate_modifier_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| name/name | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Rate
GET /api/accounts/rate
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/rate
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/rate
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/rate[/:rate_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/rate[/:rate_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/rate[/:rate_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/rate[/:rate_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| accounts | NO | ||
| accounts | NO | ||
| name | YES | ||
| type | NO | ||
| currency | YES | ||
| currency | YES | ||
| owner | YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Transaction
GET /api/accounts/transaction
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/transaction
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/transaction
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/accounts/transaction[/:transaction_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/accounts/transaction[/:transaction_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/accounts/transaction[/:transaction_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/accounts/transaction[/:transaction_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| state | NO | ||
| account | YES | ||
| invoice | NO | ||
| extId | NO | ||
| rateModifier | YES | ||
| entityType | NO | ||
| entity | NO | ||
| value | YES | ||
| transactionDate | YES | ||
| tax | NO | ||
| currency | YES | ||
| currencyValue | NO | ||
| comment | NO | ||
| eav | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/json
application/xls |
| Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.orderadmin\accounts\api.v1+json
application/hal+json
application/json
application/xls |
| Allow | Comma-separated list of all HTTP methods allowed |