ApexERPHost

<back to all web services

GetTaxDocByDocsIdWithReturn

Requires Authentication
The following routes are available for this service:
PUT/RS/TaxDocByDocsIdWithReturn
GetTaxDocByDocsIdWithReturn Parameters:
NameParameterData TypeRequiredDescription
DocsIdbodystringNo
IdsbodyList<StringLong>No
StringLong Parameters:
NameParameterData TypeRequiredDescription
StringDataformstringNo
LongDataformlong?No
GetTaxDocByDocsIdWithReturnResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformTaxDocumentNo
NotInIdsformList<StringLong>No
TaxDocument Parameters:
NameParameterData TypeRequiredDescription
IDformlongNo
INV_SERIEformstringNo
INV_NUMBERformstringNo
INV_CATEGORYformintNo
INV_TYPEformintNo
SELLER_ACTIONformintNo
BUYER_ACTIONformintNo
OPERATION_DATE_DTformDateTime?No
ACTIVATE_DATE_DTformDateTime?No
CREATE_DATE_DTformDateTime?No
CONFIRM_DATE_DTformDateTime?No
REFUSE_DATE_DTformDateTime?No
REQUEST_CANCEL_DATE_DTformDateTime?No
DELIVERY_DATE_DTformDateTime?No
AGREE_CANCEL_DATE_DTformDateTime?No
CORRECT_DATE_DTformDateTime?No
TRANS_START_DATE_DTformDateTime?No
CORRECT_REASON_IDformintNo
TIN_SELLERformstringNo
TIN_BUYERformstringNo
FOREIGN_BUYERformboolNo
NAME_SELLERformstringNo
NAME_BUYERformstringNo
SEQNUM_SELLERformlongNo
SEQNUM_BUYERformlongNo
SELLER_STATUSformintNo
BUYER_STATUSformintNo
STATUS_TXT_GEOformstringNo
STATUS_TXT_ENGformstringNo
AMOUNT_FULLformdecimalNo
AMOUNT_EXCISEformdecimalNo
AMOUNT_VATformdecimalNo
AMOUNT_MAXformdecimalNo
TRANS_START_ADDRESSformstringNo
TRANS_END_ADDRESSformstringNo
TRANS_START_ADDRESS_NOformstringNo
TRANS_END_ADDRESS_NOformstringNo
TRANS_TYPEformintNo
TRANS_TYPE_TXTformstringNo
TRANS_COMPANY_TINformstringNo
TRANS_COMPANY_NAMEformstringNo
TRANS_DRIVER_TINformstringNo
TRANS_DRIVER_FOREIGNformboolNo
TRANS_DRIVER_NAMEformstringNo
TRANS_DRIVER_COUNTRYformintNo
TRANS_CAR_MODELformstringNo
TRANS_CAR_NOformstringNo
TRANS_TRAILER_NOformstringNo
TRANS_COSTformdecimalNo
TRANS_COST_PAYERformintNo
INV_COMMENTformstringNo
PARENT_IDformlongNo
PREV_CORRECTION_IDformlongNo
NEXT_CORRECTION_IDformlongNo
INV_SOURCEformintNo
TEMPLATE_NAMEformstringNo
USER_ROLEformintNo
INVOICE_GOODSformList<TaxDocGoods>No
INVOICE_PARENT_GOODSformList<TaxDocGoods>No
INVOICE_RETURNformList<ReturnTaxDocument>No
SUB_INVOICES_DISTRIBUTIONformList<SubTaxDocument>No
INVOICE_ADVANCEformList<SubTaxDocument>No
TRANSACTION_IDformGuid?No
DOCS_IDformstringNo
FX_UNIDformGuid?No
TaxDocGoods Parameters:
NameParameterData TypeRequiredDescription
IDformlongNo
INVOICE_IDformlongNo
INV_TYPEformintNo
INV_CATEGORYformintNo
GOODS_NAMEformstringNo
BARCODEformstringNo
UNIT_IDformintNo
UNIT_TXTformstringNo
QUANTITYformdecimalNo
QUANTITY_STOCKformdecimalNo
QUANTITY_EXTformdecimalNo
UNIT_PRICEformdecimalNo
AMOUNTformdecimalNo
VAT_AMOUNTformdecimalNo
VAT_TYPEformintNo
VAT_TYPE_TXTformstringNo
EXCISE_AMOUNTformdecimalNo
EXCISE_AMOUNT_TXTformstringNo
EXCISE_IDformintNo
EXCISE_UNIT_PRICEformdecimalNo
ReturnTaxDocument Parameters:
NameParameterData TypeRequiredDescription
RETURN_INVOICE_IDformlongNo
CORRECTED_INVOICE_IDformlongNo
INV_NUMBERformstringNo
INV_SERIEformstringNo
INV_STATUSformintNo
BUYERformstringNo
OPERATION_DATE_DTformDateTime?No
SubTaxDocument Parameters:
NameParameterData TypeRequiredDescription
IDformlongNo
PARENT_INVOICE_IDformlongNo
OPERATION_DATE_DTformDateTime?No
AMOUNTformdecimalNo
INV_NUMBERformstringNo
INV_SERIEformstringNo
INV_STATUSformintNo
BUYERformstringNo
SELLERformstringNo
INV_CATEGORYformintNo
INV_TYPEformintNo
AMOUNT_FULLformdecimalNo
AMOUNT_MAXformdecimalNo
ACTIVATE_DATE_DTformDateTime?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.

PUT /RS/TaxDocByDocsIdWithReturn HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DocsId: String,
	Ids: 
	[
		{
			StringData: String,
			LongData: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	{
		ID: 0,
		INV_SERIE: String,
		INV_NUMBER: String,
		INV_CATEGORY: 0,
		INV_TYPE: 0,
		SELLER_ACTION: 0,
		BUYER_ACTION: 0,
		OPERATION_DATE_DT: 0001-01-01,
		ACTIVATE_DATE_DT: 0001-01-01,
		CREATE_DATE_DT: 0001-01-01,
		CONFIRM_DATE_DT: 0001-01-01,
		REFUSE_DATE_DT: 0001-01-01,
		REQUEST_CANCEL_DATE_DT: 0001-01-01,
		DELIVERY_DATE_DT: 0001-01-01,
		AGREE_CANCEL_DATE_DT: 0001-01-01,
		CORRECT_DATE_DT: 0001-01-01,
		TRANS_START_DATE_DT: 0001-01-01,
		CORRECT_REASON_ID: 0,
		TIN_SELLER: String,
		TIN_BUYER: String,
		FOREIGN_BUYER: False,
		NAME_SELLER: String,
		NAME_BUYER: String,
		SEQNUM_SELLER: 0,
		SEQNUM_BUYER: 0,
		SELLER_STATUS: 0,
		BUYER_STATUS: 0,
		STATUS_TXT_GEO: String,
		STATUS_TXT_ENG: String,
		AMOUNT_FULL: 0,
		AMOUNT_EXCISE: 0,
		AMOUNT_VAT: 0,
		AMOUNT_MAX: 0,
		TRANS_START_ADDRESS: String,
		TRANS_END_ADDRESS: String,
		TRANS_START_ADDRESS_NO: String,
		TRANS_END_ADDRESS_NO: String,
		TRANS_TYPE: 0,
		TRANS_TYPE_TXT: String,
		TRANS_COMPANY_TIN: String,
		TRANS_COMPANY_NAME: String,
		TRANS_DRIVER_TIN: String,
		TRANS_DRIVER_FOREIGN: False,
		TRANS_DRIVER_NAME: String,
		TRANS_DRIVER_COUNTRY: 0,
		TRANS_CAR_MODEL: String,
		TRANS_CAR_NO: String,
		TRANS_TRAILER_NO: String,
		TRANS_COST: 0,
		TRANS_COST_PAYER: 0,
		INV_COMMENT: String,
		PARENT_ID: 0,
		PREV_CORRECTION_ID: 0,
		NEXT_CORRECTION_ID: 0,
		INV_SOURCE: 0,
		TEMPLATE_NAME: String,
		USER_ROLE: 0,
		INVOICE_GOODS: 
		[
			{
				ID: 0,
				INVOICE_ID: 0,
				INV_TYPE: 0,
				INV_CATEGORY: 0,
				GOODS_NAME: String,
				BARCODE: String,
				UNIT_ID: 0,
				UNIT_TXT: String,
				QUANTITY: 0,
				QUANTITY_STOCK: 0,
				QUANTITY_EXT: 0,
				UNIT_PRICE: 0,
				AMOUNT: 0,
				VAT_AMOUNT: 0,
				VAT_TYPE: 0,
				VAT_TYPE_TXT: String,
				EXCISE_AMOUNT: 0,
				EXCISE_AMOUNT_TXT: String,
				EXCISE_ID: 0,
				EXCISE_UNIT_PRICE: 0
			}
		],
		INVOICE_PARENT_GOODS: 
		[
			{
				ID: 0,
				INVOICE_ID: 0,
				INV_TYPE: 0,
				INV_CATEGORY: 0,
				GOODS_NAME: String,
				BARCODE: String,
				UNIT_ID: 0,
				UNIT_TXT: String,
				QUANTITY: 0,
				QUANTITY_STOCK: 0,
				QUANTITY_EXT: 0,
				UNIT_PRICE: 0,
				AMOUNT: 0,
				VAT_AMOUNT: 0,
				VAT_TYPE: 0,
				VAT_TYPE_TXT: String,
				EXCISE_AMOUNT: 0,
				EXCISE_AMOUNT_TXT: String,
				EXCISE_ID: 0,
				EXCISE_UNIT_PRICE: 0
			}
		],
		INVOICE_RETURN: 
		[
			{
				RETURN_INVOICE_ID: 0,
				CORRECTED_INVOICE_ID: 0,
				INV_NUMBER: String,
				INV_SERIE: String,
				INV_STATUS: 0,
				BUYER: String,
				OPERATION_DATE_DT: 0001-01-01
			}
		],
		SUB_INVOICES_DISTRIBUTION: 
		[
			{
				ID: 0,
				PARENT_INVOICE_ID: 0,
				OPERATION_DATE_DT: 0001-01-01,
				AMOUNT: 0,
				INV_NUMBER: String,
				INV_SERIE: String,
				INV_STATUS: 0,
				BUYER: String,
				SELLER: String,
				INV_CATEGORY: 0,
				INV_TYPE: 0,
				AMOUNT_FULL: 0,
				AMOUNT_MAX: 0,
				ACTIVATE_DATE_DT: 0001-01-01
			}
		],
		INVOICE_ADVANCE: 
		[
			{
				ID: 0,
				PARENT_INVOICE_ID: 0,
				OPERATION_DATE_DT: 0001-01-01,
				AMOUNT: 0,
				INV_NUMBER: String,
				INV_SERIE: String,
				INV_STATUS: 0,
				BUYER: String,
				SELLER: String,
				INV_CATEGORY: 0,
				INV_TYPE: 0,
				AMOUNT_FULL: 0,
				AMOUNT_MAX: 0,
				ACTIVATE_DATE_DT: 0001-01-01
			}
		],
		TRANSACTION_ID: 00000000000000000000000000000000,
		DOCS_ID: String,
		FX_UNID: 00000000000000000000000000000000
	},
	NotInIds: 
	[
		{
			StringData: String,
			LongData: 0
		}
	]
}