Invoices
Invoices can only be created by Snap, Invoices are allocated on an Ad Account basis and can be fetched by an member with one of the following roles, Organization Admin, Ad Account Admin, or Campaign Manager.
Attributes
| Attribute | Description | Possible Values |
|---|---|---|
| org_id | Organization ID | |
| invoice_id | Invoice ID | |
| netsuite_file_id | Snap Internal ID | |
| ad_account_id | Ad Account ID | |
| customer.name | Customer name | |
| customer.netsuite_id | Snap Internal ID | |
| document_number | Document number | |
| line_last_modified | Date | |
| last_modified | Date | |
| amount_cent | Invoice amount in cents | |
| currency | Currency of the invoice | AUD, CAD, EUR, GBP, USD, SEK, DKK, NOK |
| billing_period | Specifies the billing period | |
| due_date | Due date of the invoice | |
| created_at | Creation date of the invoice | |
| invoice_status | Indicates whether the invoice has been collected | COLLECTED, SENT_FOR_COLLECTION |
| invoice_content | Bytestream (Base64), this Bytestream can turned into a PDF |
List invoices by Ad Account
curl "https://adsapi.snapchat.com/v1/adaccounts/88cdd2d0-b604-455a-925b-b8eb68823e48/invoices" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5f0f19d700ff0306e63ea5ff00980001737e616473617069736300016275696c642d61646161313865312d312d3336372d3000010102",
"invoices": [
{
"sub_request_status": "SUCCESS",
"invoice": {
"org_id": "8ba72a1b-0901-4b9e-951a-e39b9ad27aa3",
"invoice_id": "861b7c55-7e35-4348-918f-3758db350b80",
"netsuite_file_id": "5910692",
"ad_account_id": "88cdd2d0-b604-455a-925b-b8eb68823e48",
"customer": {
"name": "Badger Tunneling Inc.",
"netsuite_id": "8828020"
},
"document_number": "146810",
"line_last_modified": "2020-05-14T08:20:00.000Z",
"last_modified": "2020-05-14T08:20:00.000Z",
"amount_cent": 1171496,
"currency": "USD",
"billing_period": "April 2020",
"due_date": "2020-06-05T00:00:00.000Z",
"created_at": "2020-05-02T06:45:00.000Z",
"invoice_status": "COLLECTED"
}
},
{
"sub_request_status": "SUCCESS",
"invoice": {
"org_id": "8ba72a1b-0901-4b9e-951a-e39b9ad27aa3",
"invoice_id": "8848a897-e1b7-4433-a9a1-78fbafb5d52b",
"netsuite_file_id": "8036582",
"ad_account_id": "88cdd2d0-b604-455a-925b-b8eb68823e48",
"customer": {
"name": "Badger Tunneling Inc.",
"netsuite_id": "8828020"
},
"document_number": "151141",
"line_last_modified": "2020-06-09T08:34:00.000Z",
"last_modified": "2020-06-09T08:34:00.000Z",
"amount_cent": 375222,
"currency": "USD",
"billing_period": "May 2020",
"due_date": "2020-07-05T00:00:00.000Z",
"created_at": "2020-06-02T07:05:00.000Z",
"invoice_status": "COLLECTED"
}
},
{
"sub_request_status": "SUCCESS",
"invoice": {
"org_id": "8ba72a1b-0901-4b9e-951a-e39b9ad27aa3",
"invoice_id": "8be7c07f-b1dc-4aca-9729-348bf05b67a6",
"netsuite_file_id": "8170796",
"ad_account_id": "88cdd2d0-b604-455a-925b-b8eb68823e48",
"customer": {
"name": "Badger Tunneling Inc.",
"netsuite_id": "8828020"
},
"document_number": "154209",
"line_last_modified": "2020-07-07T16:15:00.000Z",
"last_modified": "2020-07-07T16:15:00.000Z",
"amount_cent": 1329360,
"currency": "USD",
"billing_period": "June 2020",
"due_date": "2020-08-06T00:00:00.000Z",
"created_at": "2020-07-02T04:53:00.000Z",
"invoice_status": "SENT_FOR_COLLECTION"
}
}
]
}
This endpoint will list all invoices for a given Ad Account.
HTTP Request
GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/invoices
Parameters
| Parameter | Default | Description |
|---|---|---|
| ad_account_id | Ad Account ID |
Get individual Invoice
curl "https://adsapi.snapchat.com/v1/adaccounts/04cdd2d0-b604-455a-925b-b8eb68823e48/invoices/2be7c07f-b1dc-4aca-9729-348bf05b67a6" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5f107ce000ff0da20b969610630001737e616473617069736300016275696c642d61646161313865312d312d3336372d3000010131",
"invoices": [
{
"sub_request_status": "SUCCESS",
"invoice": {
"org_id": "eba72a1b-0901-4b9e-951a-e39b9ad27aa3",
"invoice_id": "2be7c07f-b1dc-4aca-9729-348bf05b67a6",
"netsuite_file_id": "6216757",
"ad_account_id": "04cdd2d0-b604-455a-925b-b8eb68823e48",
"customer": {
"name": "Flo Health, Inc.",
"netsuite_id": "7828020"
},
"document_number": "154209",
"line_last_modified": "2020-07-15T09:03:00.000Z",
"last_modified": "2020-07-15T09:03:00.000Z",
"amount_cent": 1329360,
"currency": "USD",
"billing_period": "June 2020",
"due_date": "2020-08-06T00:00:00.000Z",
"created_at": "2020-07-02T04:53:00.000Z",
"invoice_status": "COLLECTED"
}
}
]
}
This endpoint retrieve an individual invoice for a given Ad Account
HTTP Request
GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/invoices/{invoice_id}
Parameters
| Parameter | Default | Description |
|---|---|---|
| ad_account_id | Ad Account ID | |
| invoice_id | Invoice ID | |
| include_pdf | false | optional parameter for retrieving the invoice_content attribute |
Example 1 - Invoice
Retrieving an invoice
curl "https://adsapi.snapchat.com/v1/adaccounts/9d874f18-8a86-422b-a4c0-67525472f339/invoices/93106732-4504-4220-83f6-035c30bf38a9" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5f15b33d00ff04a2f415f889b70001737e616473617069736300016275696c642d65626530306366642d312d3336382d300001014c",
"invoices": [
{
"sub_request_status": "SUCCESS",
"invoice": {
"org_id": "96412453-e008-4353-a8da-881ed5170e9c",
"invoice_id": "93106732-4504-4220-83f6-035c30bf38a9",
"netsuite_file_id": "9214559",
"ad_account_id": "9d874f18-8a86-422b-a4c0-67525472f339",
"customer": {
"name": "Hedgehogs interactive Ltd",
"netsuite_id": "90053849"
},
"document_number": "150239",
"line_last_modified": "2020-07-14T23:43:00.000Z",
"last_modified": "2020-07-14T23:43:00.000Z",
"amount_cent": 132095,
"currency": "USD",
"billing_period": "May 2020",
"due_date": "2020-07-05T00:00:00.000Z",
"created_at": "2020-06-02T02:54:00.000Z",
"invoice_status": "COLLECTED"
}
}
]
}
This example retrieves an individual invoice.
Example 2 - Invoice - invoice_content
Retrieving an invoice with invoice_content
curl "https://adsapi.snapchat.com/v1/adaccounts/9e08d5dd-023b-429e-904c-0924291dc478/invoices/9db4ab51-6402-4b20-b47b-a893267dfb3f?include_pdf=true" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5f15b5cd00ff0781f49f7748b80001737e616473617069736300016275696c642d65626530306366642d312d3336382d3000010150",
"invoices": [
{
"sub_request_status": "SUCCESS",
"invoice": {
"org_id": "97433ff4-1fb6-416f-b726-069624ac1de2",
"invoice_id": "9db4ab51-6402-4b20-b47b-a893267dfb3f",
"netsuite_file_id": "5489672",
"ad_account_id": "9e08d5dd-023b-429e-904c-0924291dc478",
"customer": {
"name": "Le Chipmunks Inc",
"netsuite_id": "1277123"
},
"document_number": "124357",
"line_last_modified": "2020-02-21T02:11:00.000Z",
"last_modified": "2020-02-21T02:11:00.000Z",
"amount_cent": 953057,
"currency": "EUR",
"billing_period": "November 2019",
"due_date": "2020-02-03T00:00:00.000Z",
"created_at": "2019-12-02T15:41:00.000Z",
"invoice_content": "JVBERi0xLjMKJd/++LIKMSAwIG9iago8PC ... emUgMzI+PgpzdGFydHhyZWYKMjY1ODQKJSVFT0YK",
"invoice_status": "COLLECTED"
}
}
]
}
This example retrieves an individual invoice for with the parameter include_pdf which adds the attribute invoice_content on the invoice
entity that is returned.
Was this page helpful?