Read a batch of invoices by internal ID, or unique property values
Leia um lote de objetos do CRM por meio de seus IDs internos ou valores de propriedades exclusivos. Este endpoint é útil para recuperar vários objetos em uma única solicitação, o que pode ser mais eficiente do que fazer solicitações individuais para cada objeto. A resposta inclui os detalhes dos objetos, e você pode especificar se deseja incluir objetos arquivados.
Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Parâmetros de consulta
Se apenas os resultados que foram arquivados devem ser retornados.
Corpo
Especifica a entrada para a leitura de um lote de objetos do CRM, incluindo matrizes de IDs de objetos, nomes de propriedades solicitadas (com histórico opcional) e uma propriedade de identificação exclusiva opcional.
Uma matriz de objetos SimplePublicObjectId que representam os IDs dos objetos a serem lidos.
Uma matriz de strings que especifica as propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.
Uma matriz de strings que especifica as propriedades a serem retornadas junto com o histórico de seus valores anteriores. O uso desse parâmetro pode reduzir o número máximo de objetos que podem ser lidos em uma única solicitação.
Ao usar uma propriedade de valor exclusivo personalizada para recuperar registros, este é o nome da propriedade. Não inclua esse parâmetro se estiver recuperando por ID de registro.
Resposta
successful operation
Um objeto de resposta em lote de objeto público
A data e hora em que a operação em lote foi concluída, no formato ISO 8601.
Uma matriz de resultados da operação em lote, cada item sendo um objeto público simples.
A data e a hora em que a operação em lote foi iniciada, no formato ISO 8601.
O status atual da operação em lote. Os valores válidos incluem 'PENDENTE', 'PROCESSANDO', 'CANCELADO' e 'CONCLUÍDO'.
CANCELED, COMPLETE, PENDING, PROCESSING Um mapa de nomes de links para URIs associadas relacionadas à operação em lote.
A data e a hora em que a operação em lote foi solicitada, no formato ISO 8601.