Authorization

OAuth 2.0 Authorization Code Flow
- Get Authorization codeget
- Create or refresh access tokenpost

Candis API

Exports
Organizations
- Get Organizationget
Core Data
Invoices
- List invoices of the organizationget

Authorization

OAuth 2.0 Authorization Code Flow
- Get Authorization codeget
- Create or refresh access tokenpost

Candis API

Exports
Organizations
- Get Organizationget
Core Data
Invoices
- List invoices of the organizationget

Get an Export

get https://api.candis.io/v1/organizations/{organizationId}/exports/{exportId}

Get an Export details by ID.

Path Params

exportId

string

required

The export ID.

organizationId

string

required

The organization ID.

Responses

Response body

object

string

required

The unique identifier of the export.

postingsCount

number

required

The number of postings in the export.

status

string

required

Current status of the export.

EXPORTING: The export processing is still in progress.
EXPORTED: The export is completed.
FAILED: The export failed.
PARTIALLY_EXPORTED: The export was partially successful.

EXPORTING EXPORTED FAILED PARTIALLY_EXPORTED

createdAt

date-time

required

The date and time when the export was initiated.

Response body

object

errorCode

string

required

The Error Code assigned to the issue encountered

UNAUTHORIZED FORBIDDEN BAD_REQUEST SERVICE_UNAVAILABLE INTERNAL_SERVER_ERROR MISSING_REQUESTER_ID BAD_INPUT NOT_FOUND EXPORTABLE_POSTINGS_NOT_FOUND TOO_MANY_REQUEST FAILED_TO_FETCH_DOWNLOAD_URL FILE_NOT_FOUND

message

string

required

Description about the issue encountered

requestId

string

This is the unique identifier for the request.

errors

array of objects

This is an optional output that can provide more details about the input parameters that may have caused an issue.

errors

object

index

string

This identifies the index of the payload that has an issue.

property

string

required

This identifies the parameter that has an issue.

messages

array of strings

required

This provides more details about the parameter that has an issue.

messages*

Response body

object

errorCode

string

required

The Error Code assigned to the issue encountered

message

string

required

Description about the issue encountered

requestId

string

This is the unique identifier for the request.

errors

array of objects

This is an optional output that can provide more details about the input parameters that may have caused an issue.

errors

object

index

string

This identifies the index of the payload that has an issue.

property

string

required

This identifies the parameter that has an issue.

messages

array of strings

required

This provides more details about the parameter that has an issue.

messages*

Response body

object

errorCode

string

required

The Error Code assigned to the issue encountered

message

string

required

Description about the issue encountered

requestId

string

This is the unique identifier for the request.

Updated 7 months ago

Get a list Exports

Get a list of Export Postings

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.candis.io/v1/organizations/organizationId/exports/exportId \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "id": "86e29aff-ba75-492d-85f6-80d802c4fe69",
3
  "postingsCount": 10,
4
  "status": "EXPORTED",
5
  "createdAt": "2024-01-01T12:00:00Z"
6
}

Updated 7 months ago

Get a list Exports

Get a list of Export Postings

Did this page help you?

Authorization
OAuth 2.0 Authorization Code Flow
Create or refresh access tokenpost
Get Authorization codeget

Candis API
Exports
Download file by IDget
Get a list of Export Postingsget
Get an Exportget
Get a list Exportsget
Create an Exportpost
Organizations
Get Organizationget
Core Data
Get Import Logsget
Payment Conditions
Update Payment Conditionsput
Create Payment Conditionspost
Contacts
Update Contactput
Create Contactspost
Tax Codes
Update Tax Codesput
Create Tax Codespost
Cost Centers and Cost Objects
Update Cost Centers and Cost Objectsput
Create Cost Centers and Cost Objectspost
General Ledger Accounts
Update General Ledger Accountsput
Create General Ledger Accountspost
Invoices
List invoices of the organizationget

Authorization
OAuth 2.0 Authorization Code Flow
Create or refresh access tokenpost
Get Authorization codeget

Candis API
Exports
Download file by IDget
Get a list of Export Postingsget
Get an Exportget
Get a list Exportsget
Create an Exportpost
Organizations
Get Organizationget
Core Data
Get Import Logsget
Payment Conditions
Update Payment Conditionsput
Create Payment Conditionspost
Contacts
Update Contactput
Create Contactspost
Tax Codes
Update Tax Codesput
Create Tax Codespost
Cost Centers and Cost Objects
Update Cost Centers and Cost Objectsput
Create Cost Centers and Cost Objectspost
General Ledger Accounts
Update General Ledger Accountsput
Create General Ledger Accountspost
Invoices
List invoices of the organizationget

200

400

404

503