Atlas API Version

Oracle Transaction

Reading

A monthly invoice generated for an Atlas campaign.

Example

Graph API Explorer
GET /v3.0/{oracle-transaction-id} 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(
    '/{oracle-transaction-id}',
    '{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(
    "/{oracle-transaction-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{oracle-transaction-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{oracle-transaction-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
ad_account_ids
list<numeric string>

The list of ad account ids this invoice is about

id
numeric string

Internal id for the invoice

amount
numeric string

The amount of the invoice

amount_due

The amount left to be paid, it is equal to the billed amount minus already paid amount

billed_amount_details
BilledAmountDetails

Details of the billed amount, include currency, next, tax and total amount

billing_period
string

The billing period associated with the invoice

currency
string

The currency of the invoice

download_uri
string

The download URI for the invoice pdf

due_date
datetime

Date by which this invoice is due

entity
enum

The Facebook Entity name for the transaction

invoice_date
datetime

Date of creation of the invoice

invoice_id
numeric string

Actual invoice id for the transaction

invoice_type
enum

The type of invoice, like Invoice or Credit Memo

liability_type
enum

The liability type associated with usage of this funding source

payment_status
enum

Payment status of the invoice, e.g. 'Paid', 'Partially Paid'

payment_term
enum

The expectation around when the invoice is paid. E.g. 'Net 30' implies we expect payment within 30 days

type
enum

The type of the invoice

Edges

EdgeDescription

campaigns

The breakdown spend at campaign level, including additioanl info on campaign

data

Redirect link to the invoice

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.