Special arguments

Get special arguments list

GET /special_arguments/list

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_arguments/list

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_arguments>
		<special_argument>
			<status>
				<estimate>
					<item>
						<value>draft</value>
						<translation>Créé</translation>
					</item>
					<item>
					...
					</item>
				</estimate>
				<purchaseorder>
				...
				</purchaseorder>
				...
			</status>
		</special_argument>
		<special_argument>
		...
		</special_argument>
	</special_arguments>
</xml> 


Top


status

Argument Type Value
status string For estimates:
  • “draft” when created
  • “sent” when sent
  • “signed” when signed
  • “unsigned” when unsigned/expired
  • “invoiced” when invoiced
  • “abandonned” when abandonned


For purchase orders:

  • “draft” when created
  • “sent” when sent


For invoices:

  • “draft” when created
  • “sent” when sent


For packing lists:

  • “draft” when created
  • “sent” when sent
  • “delivered” when delivered

GET /special_arguments/status

cURL request example

curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_arguments/status

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_argument>
		<status>
			<estimate>
				<item>
					<value>draft</value>
					<translation>Créé</translation>
				</item>
				<item>
				...
				</item>
			</estimate>
			<purchaseorder>
			...
			</purchaseorder>
			<invoice>
			...
			</invoice>
			<packinglist>
			...
			</packinglist>
		</status>
	</special_argument>
</xml> 


Top


operator

Argument Type Value
#{key}_operator string
  • “eq” for equal
  • “lt” for less than
  • “lteq” for less than or equal
  • “gt” for greater than
  • “gte” for greater than or equal

GET /special_arguments/operator

cURL request example

	
curl -u #:#{password}'\
-H 'User-Agent: #{user_agent}'\
-X GET https://#{subdomain}.iscriba.com/api/special_arguments/operator

XML response example

HTTP Status: 200 OK

<?xml version="1.0" encoding="utf-8"?> 
<xml>
	<special_argument>
		<operator>
			<item>
				<value>eq</value>
				<translation>=</translation>
			</item>
			<item>
				<value>lt</value>
				<translation>&lt;</translation>
			</item>
			<item>
			...
			</item>
		</operator>
	</special_argument>
</xml> 

Top