Basecone Developers

Retrieve periods from the Basecone office where you're user has rights to.

GET periods?companyid=:companyId&externalId=:id

Request properties

Property	Type	Description	Optional
externalId	String	External period unique Identifier.	Yes
companyId	Guid	Company unique Identifier.	No

Periods collection properties

Property	Type	Description
periodId	Guid	Unique identifier of period
Year	int	Year of period
Number	int	Name of period
externalId	string	External identifier from accounting system
IsOpen	boolean	If the period is open or closed

For details on period properties see period details.

For details on collections see collection details.

Example response:

{
    "periods" : [{
	    "periodId" : "f4870a4c-1b97-49b6-ad37-a71a00a07555",
	    "_links" : [{
		    "rel" : "self",
		    "href" : "https://api.basecone.com/v1/periods/f4870a4c-1b97-49b6-ad37-a71a00a07555"
	    }],
	    "externalId" : "1234",
	    "year" : 2017,
	    "number" : 0,
	    "isOpen" : true
    }],
    "_links" : [{
	    "rel" : "self",
	    "href" : "https://api.basecone.com/v1/periods?limit=20&offset=0"
    }],
    "_metadata" : {
	    "total" : 1,
	    "count" : 1
    }
}