Versão Graph API

Business Business Invoices

Leitura

The monthly invoices sent to the bill-to legal entities associated to a business.

Returns https://developers.facebook.com/docs/marketing-api/reference/omega-customer-trx/

Exemplo

Graph API Explorer
GET /v21.0/{business-id}/business_invoices HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{business-id}/business_invoices',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{business-id}/business_invoices",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-id}/business_invoices",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-id}/business_invoices"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Se quiser saber como usar a Graph API, leia nosso guia sobre Como usar a Graph API.

Parâmetros

ParâmetroDescrição
end_date
string
Valor padrão: "2024-11-02"

End date for querying invoices by their billing period timestamp.

The billing period timestamp of an invoice is the first day of the month for which we're invoicing (i.e. a June 2021 invoice will have billing period of May 1st, 2021 = 2021-05-01).

Expected date format: YYYY-MM-DD.

Note: end_date is exclusive.

invoice_id
string

Corresponds to the invoice number (i.e. the "invoice_id" field on the OmegaCustomerTrx node) for a particular invoice/credit memo.

Used to query for a single invoice. If set, all other filter parameters are ignored.

issue_end_date
string
Valor padrão: "2024-11-02"

End date for querying invoices by the date in which they're issued.

Expected date format: YYYY-MM-DD.

Note: issue_end_date is exclusive.

issue_start_date
string

Start date for querying invoices by the date in which they're issued.

Expected date format: YYYY-MM-DD.

Note: issue_start_date is inclusive. Also, this parameter must be set in order to query by the issue date.

root_id
int64

Corresponds to the id (i.e. the "id" field on the OmegaCustomerTrx node) for a particular invoice/credit memo.

Used to query for a single invoice. If set, all other filter parameters are ignored.

start_date
string
Valor padrão: "First day of 6 months ago"

Start date for querying invoices by their billing period timestamp.

The billing period timestamp of an invoice is the first day of the month for which we're invoicing (i.e. a June 2021 invoice will have billing period of May 1st, 2021 = 2021-05-01).

Expected date format: YYYY-MM-DD.

Note: start_date is exclusive. Also, start_date and end_date have a default value, so if no parameters are set, invoices are queried by the billing period

type
enum {INV, CM, DM, PRO_FORMA}

Used to query invoices by their type, which can be 'INV': Invoice or 'CM': Credit Memo.

Campos

A leitura desta borda retornará um resultado formatado em JSON:

{ "data": [], "paging": {} }

data

Uma lista de nós OmegaCustomerTrx.

paging

Para saber mais detalhes sobre paginação, consulte o Guia da Graph API.

Error Codes

ErroDescrição
104Incorrect signature
200Permissions error

Criando

Não é possível executar esta operação neste ponto de extremidade.

Atualizando

Não é possível executar esta operação neste ponto de extremidade.

Excluindo

Não é possível executar esta operação neste ponto de extremidade.