POS365.VN APIs

<back to all web services

DeclarationDetail

Requires Authentication
The following routes are available for this service:
GET/api/declarations/{Id}
DeclarationDetail Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
Declaration Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
BranchIdformintNo
RetailerIdformintNo
TaxCodeformstringNo
PeriodTypeformbyteNo
PeriodYearformintNo
PeriodValueformbyteNo
DueDateformDateTimeNo
TaxAmountformdecimalNo
StatusformbyteNo
PaymentStatusformbyteNo
SubmissionSequenceformintNo
RequestIdformGuidNo
CreatedByformlongNo
CreatedDateformDateTimeNo
ModifiedByformlong?No
ModifiedDateformDateTime?No
DeclarationInfoformDeclarationInfoNo
DeclarationSyncformDeclarationSyncNo
DeclarationInfo Parameters:
NameParameterData TypeRequiredDescription
DeclarationIdformlongNo
RetailerIdformintNo
BranchIdformintNo
TaxpayerNameformstringNo
BrandNameformstringNo
PhoneNumberformstringNo
EmailformstringNo
TaxpayerCodeformstringNo
NewTaxpayerCodeformstringNo
BusinessSectorIdsformstringNo
IsRevisedformboolNo
AddressDetailformstringNo
ProvinceIdformint?No
WardIdformint?No
BusinessAreaformdoubleNo
PremisesTypeformboolNo
BorderBusinessformboolNo
BorderMarketNameformstringNo
TaxDepartmentIdformint?No
TaxOfficeIdformint?No
ResidentialAddressformstringNo
ResidentialProvinceIdformint?No
ResidentialWardIdformint?No
NumberOfEmployeesformint?No
WorkingHourFromformTimeSpan?No
WorkingHourToformTimeSpan?No
BankAccountformstringNo
DeclarationSync Parameters:
NameParameterData TypeRequiredDescription
DeclarationIdformlongNo
BranchIdformintNo
RetailerIdformintNo
RequestIdformGuidNo
StatusformbyteNo
SignStatusformbyteNo
TvanStatusformbyteNo
SignValueformstringNo
ProviderCodeformstringNo
MaCqtformstringNo
RequestPayloadformstringNo
ResponsePayloadformstringNo
ErrorMessageformstringNo
CreatedDateformDateTimeNo
CreatedByformlongNo
ModifiedByformlong?No
ModifiedDateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/declarations/{Id} HTTP/1.1 
Host: api.pos365.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	BranchId: 0,
	RetailerId: 0,
	TaxCode: String,
	PeriodType: 0,
	PeriodYear: 0,
	PeriodValue: 0,
	DueDate: 0001-01-01,
	TaxAmount: 0,
	Status: 0,
	PaymentStatus: 0,
	SubmissionSequence: 0,
	RequestId: 00000000000000000000000000000000,
	CreatedBy: 0,
	CreatedDate: 0001-01-01,
	ModifiedBy: 0,
	ModifiedDate: 0001-01-01,
	DeclarationInfo: 
	{
		DeclarationId: 0,
		RetailerId: 0,
		BranchId: 0,
		TaxpayerName: String,
		BrandName: String,
		PhoneNumber: String,
		Email: String,
		TaxpayerCode: String,
		NewTaxpayerCode: String,
		BusinessSectorIds: String,
		IsRevised: False,
		AddressDetail: String,
		ProvinceId: 0,
		WardId: 0,
		BusinessArea: 0,
		PremisesType: False,
		BorderBusiness: False,
		BorderMarketName: String,
		TaxDepartmentId: 0,
		TaxOfficeId: 0,
		ResidentialAddress: String,
		ResidentialProvinceId: 0,
		ResidentialWardId: 0,
		NumberOfEmployees: 0,
		WorkingHourFrom: PT0S,
		WorkingHourTo: PT0S,
		BankAccount: String
	},
	DeclarationSync: 
	{
		DeclarationId: 0,
		BranchId: 0,
		RetailerId: 0,
		RequestId: 00000000000000000000000000000000,
		Status: 0,
		SignStatus: 0,
		TvanStatus: 0,
		SignValue: String,
		ProviderCode: String,
		MaCqt: String,
		RequestPayload: String,
		ResponsePayload: String,
		ErrorMessage: String,
		CreatedDate: 0001-01-01,
		CreatedBy: 0,
		ModifiedBy: 0,
		ModifiedDate: 0001-01-01
	}
}