🖇️Documents

API Endpoints for Documents

List Documents GET

Endpoint: https://subdomain.appcrm.com.br/api/documents

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Query Parameters

order	Optional	string	Sort the results being queried. Example: ?order=created_at or ?order=created_at|desc
select	Optional	string	Select only the provided fields, useful for query optimization. Example: ?select=first_name;id
per_page	Optional	integer	Provide the total number of records to query per page. Example: ?per_page=20
page	Optional	integer	The page number to retrieve results for. Example: ?page=2
q	Optional	string	Search records by a given query. Example: ?q=John
search_fields	Optional	string	Change the fields that the search will be performed to Example:?search_fields=email:like;phones.number:=
search_match	Optional	string	By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator. Example: ?search_match=and

Retrieve Document GET

Endpoint: https://subdomain.appcrm.com.br/api/documents/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Create Documents POST

Endpoint: https://subdomain.appcrm.com.br/api/documents

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Body Parameters

title	Required	string
brand_id	Required	integer
document_type_id	Required	integer	ID of the document type
user_id	Required	integer	Owner of the document
locale	Optional	string	If not provided, uses the current user locale.
view_type	Optional	string	Any of ['nav-top', 'nav-left', 'nav-left-full-width'] Default value is nav-top
requires_signature	Optional	boolean
content	Optional	string
signers	Optional	array	Example: [ [ "name" => "Joseph", "email" => "[email protected]", "send_email": true ] ]
recipients	Optional	array	Example: [ [ "name" => "Joseph Doe", "email" => "[email protected]", "send_email": true ] ]
billable	Optional	array	products Optional array Array of products to be attached to the billable object See Product Metadata tax_type Optional string Any of ['exclusive', 'inclusive', 'no_tax'] If not provided, the default selected tax type in Settings -> Products will be used. Product metadata id Optional integer Billable product ID, used to update an existing billable product. You don't need to provide such value when adding new products to the billable, provide the value when updating only. product_id Optional integer The product ID from the products resource. If not provided, App CRM will search for an existing product with the same name and if no such product, will create new product. name Required string Product name description Optional string Product description unit_price Required number Unit price - The price of each unit sold qty Optional number Product quantity (default 1) discount_type Optional string Any of ['percent', 'fixed'] discount_total Optional number Percentage if discount_type is percent or total discount amount if discount_type is fixed tax_label Optional string tax_rate Optional number unit Optional string
send	Optional	boolean	Indicates whether the document should be sent to the recipients after save.
send_mail_account_id	Optional	integer	Applicable only if send is set as true
send_mail_body	Optional	string	Applicable only if send is set as true
send_mail_subject	Optional	string	Applicable only if send is set as true
companies	Optional	array	Array of company ID's the document is associated with.
contacts	Optional	array	Array of contact ID's the document is associated with.
deals	Optional	array	Array of deal ID's the document is associated with.

Update Document PUT

Endpoint: https://subdomain.appcrm.com.br/api/documents/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Body Parameters

title	Required	string
brand_id	Required	integer
document_type_id	Required	integer	ID of the document type
user_id	Required	integer	Owner of the document
locale	Optional	string	If not provided, uses the current user locale.
view_type	Optional	string	Any of ['nav-top', 'nav-left', 'nav-left-full-width'] Default value is nav-top
requires_signature	Optional	boolean
content	Optional	string
signers	Optional	array	Example: [ [ "name" => "Joseph", "email" => "[email protected]", "send_email": true ] ]
recipients	Optional	array	Example: [ [ "name" => "Joseph", "email" => "[email protected]", "send_email": true ] ]
billable	Optional	array	products Optional array Array of products to be attached to the billable object See Product Metadata removed_products Optional array An array of billable product id's to remove from the record. tax_type Optional string Any of ['exclusive', 'inclusive', 'no_tax'] If not provided, the default selected tax type in Settings -> Products will be used. Product metadata id Optional integer Billable product ID, used to update an existing billable product. You don't need to provide such value when adding new products to the billable, provide the value when updating only. product_id Optional integer The product ID from the products resource. If not provided, App CRM will search for an existing product with the same name and if no such product, will create new product. name Required string Product name description Optional string Product description unit_price Required number Unit price - The price of each unit sold qty Optional number Product quantity (default 1) discount_type Optional string Any of ['percent', 'fixed'] discount_total Optional number Percentage if discount_type is percent or total discount amount if discount_type is fixed tax_label Optional number tax_rate Optional number unit Optional string
send	Optional	boolean	Indicates whether the document should be sent to the recipients after save.
send_mail_account_id	Optional	integer	Applicable only if send is set as true
send_mail_body	Optional	string	Applicable only if send is set as true
send_mail_subject	Optional	string	Applicable only if send is set as true
companies	Optional	array	Array of company ID's the document is associated with.
contacts	Optional	array	Array of contact ID's the document is associated with.
deals	Optional	array	Array of deal ID's the document is associated with.

Delete Documents DELETE

Endpoint: https://subdomain.appcrm.com.br/api/documents/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Search Documents GET

Endpoint: https://subdomain.appcrm.com.br/api/documents/search?q={query}

Use this endpoint to perform search without pagination and use the take parameter if you need to limit the results.

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

q	Required	string

Query Parameters

take	Optional	integer	The maximum number of results to query Example: ?take=1
order	Optional	string	Sort the results being queried. Example: ?order=created_at or ?order=created_at|desc
select	Optional	string	Select only the provided fields, useful for query optimization. Example: ?select=first_name;id
search_fields	Optional	string	Change the fields that the search will be performed to Example:?search_fields=email:like;phones.number:=
search_match	Optional	string	By default the search queries are performed using the OR comparison operator for each query parameter, if you need to match all parameters, you will need to use the AND comparison operator. Example: ?search_match=and

Attach Associations to Documents PUT

Endpoint: https://subdomain.appcrm.com.br/api/associations/documents/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Make sure to provide at least one resource.

Body Parameters

companies	Optional	array	Array of companies ID's to attach
contacts	Optional	array	Array of contacts ID's to attach
deals	Optional	array	Array of deals ID's to attach

Detach Associations From Documents DELETE

Endpoint: https://subdomain.appcrm.com.br/api/associations/documents/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Make sure to provide at least one resource.

Body Parameters

companies	Optional	array	Array of companies ID's to detach
contacts	Optional	array	Array of contacts ID's to detach
deals	Optional	array	Array of deals ID's to detach

Sync Associations To Documents POST

Endpoint: https://subdomain.appcrm.com.br/api/associations/documents/{id}

Headers

Content-Type	Required	string	application/json
Accept	Required	string	application/json
Authorization	Required	string	Bearer {token}

Path Parameters

id	Required	integer	The ID of the record

Make sure to provide at least one resource.

Body Parameters

companies	Optional	array	Array of companies ID's to sync
contacts	Optional	array	Array of contacts ID's to sync
deals	Optional	array	Array of deals ID's to sync