11# Realpad Takeout API Client for PHP
22
3- //for real estate developer IT / reporting departments, integrators, and
4- other 3rd parties//
3+ * for real estate developer IT / reporting departments, integrators, and other 3rd parties*
54
65This document describes how to use the Realpad Takeout API to back up the data stored in the
76system. Both structured data (such as lists of customers, deals, etc) and files uploaded to the
@@ -44,10 +43,14 @@ crc="3826804066"/>
4443
4544● uid is the unique identifier of this resource, by which it can be retrieved using
4645get-projects.
46+
4747● content-type is the MIME type of the file, resolved when uploaded to the system (it’s
4848the best guess).
49+
4950● file-name is the original file name when it was uploaded to the system.
51+
5052● size is the file size in bytes.
53+
5154● crc is the CRC32 checksum of the file.
5255
5356This endpoint will always return all the resources. It’s up to your system to determine which
6265https://cms.realpad.eu/resource/bd5563ae-abc...
6366```
6467
65- ## Endpoints with a binary payload
68+ ## Endpoints
6669
6770All of these endpoints return a single Excel file with a .xls extension, containing all the relevant
6871data stored in our system. These endpoints behave just like get-resource, in that the HTTP
@@ -136,11 +139,14 @@ Accepts several additional optional parameters:
136139● `filter_status`` - if left empty, invoices in all statuses are sent. 1 - new invoices. 2 -
137140invoices in Review #1 . 3 - invoices in Review #2 . 4 - invoices in approval. 5 - fully
138141approved invoices. 6 - fully rejected invoices.
142+
139143●` filter_groupcompany ` - if left empty, invoices from all the group companies are sent. If
140144Realpad database IDs of group companies are provided (as a comma-separated list),
141145then only invoices from these companies are sent.
146+
142147● `filter_issued_from`` - specify a date in the 2019-12-31 format to only send invoices
143148issues after that date.
149+
144150● ` filter_issued_to ` - specify a date in the 2019-12-31 format to only send invoices issues
145151before that date.
146152The initial set of columns describes the Invoice itself, and the last set of columns contains the
@@ -150,32 +156,59 @@ data of its Lines.
150156
151157Unit status enumeration
152158● 0 - free.
159+
153160● 1 - pre-reserved.
161+
154162● 2 - reserved.
163+
155164● 3 - sold.
165+
156166● 4 - not for sale.
167+
157168● 5 - delayed.
158169
159170Unit type enumeration
171+
160172● 1 - flat.
173+
161174● 2 - parking.
175+
162176● 3 - cellar.
177+
163178● 4 - outdoor parking.
179+
164180● 5 - garage.
181+
165182● 6 - commercial space.
183+
166184● 7 - family house.
185+
167186● 8 - land.
187+
168188● 9 - atelier.
189+
169190● 10 - office.
191+
170192● 11 - art workshop.
193+
171194● 12 - non-residential unit.
195+
172196● 13 - motorbike parking.
197+
173198● 14 - creative workshop.
199+
174200● 15 - townhouse.
201+
175202● 16 - utility room.
203+
176204● 17 - condominium.
205+
177206● 18 - storage.
207+
178208● 19 - apartment.
209+
179210● 20 - accommodation unit.
211+
180212● 21 - bike stand.
213+
181214● 22 - communal area.
0 commit comments